blob: b44f597ed7c136f9a359f488dad750f319eab13b [file] [log] [blame]
Anand Doshi885e0742015-03-03 14:55:30 +05301# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
Nabin Hait3237c752015-02-17 11:11:11 +05302# License: GNU General Public License v3. See license.txt
3
4from __future__ import unicode_literals
5import json
Rushabh Mehtacc8b2b22017-03-31 12:44:29 +05306import frappe, erpnext
Nabin Hait3769d872015-12-18 13:12:02 +05307from frappe import _, scrub
Nabin Haitb962fc12017-07-17 18:02:31 +05308from frappe.utils import cint, flt, round_based_on_smallest_currency_fraction
Nabin Hait613d0812015-02-23 11:58:15 +05309from erpnext.controllers.accounts_controller import validate_conversion_rate, \
10 validate_taxes_and_charges, validate_inclusive_tax
Nabin Hait3237c752015-02-17 11:11:11 +053011
Nabin Haitfe81da22015-02-18 12:23:18 +053012class calculate_taxes_and_totals(object):
Nabin Hait3237c752015-02-17 11:11:11 +053013 def __init__(self, doc):
14 self.doc = doc
Nabin Haitfe81da22015-02-18 12:23:18 +053015 self.calculate()
16
Nabin Hait3237c752015-02-17 11:11:11 +053017 def calculate(self):
18 self.discount_amount_applied = False
19 self._calculate()
20
21 if self.doc.meta.get_field("discount_amount"):
Nabin Hait3769d872015-12-18 13:12:02 +053022 self.set_discount_amount()
Nabin Hait3237c752015-02-17 11:11:11 +053023 self.apply_discount_amount()
24
Nabin Haitbd00e812015-02-17 12:50:51 +053025 if self.doc.doctype in ["Sales Invoice", "Purchase Invoice"]:
Nabin Hait3237c752015-02-17 11:11:11 +053026 self.calculate_total_advance()
Vishal Dhayaguded42242d2017-11-29 16:09:59 +053027
Nabin Hait852cb642017-07-05 12:58:19 +053028 if self.doc.meta.get_field("other_charges_calculation"):
29 self.set_item_wise_tax_breakup()
Nabin Hait3237c752015-02-17 11:11:11 +053030
31 def _calculate(self):
Faris Ansarieae2dda2018-05-02 12:19:30 +053032 self.validate_conversion_rate()
Nabin Haite7679702015-02-20 14:40:35 +053033 self.calculate_item_values()
34 self.initialize_taxes()
35 self.determine_exclusive_rate()
36 self.calculate_net_total()
37 self.calculate_taxes()
Nabin Haita1bf43b2015-03-17 10:50:47 +053038 self.manipulate_grand_total_for_inclusive_tax()
Nabin Haite7679702015-02-20 14:40:35 +053039 self.calculate_totals()
40 self._cleanup()
rohitwaghchaurea8fb2db2018-05-26 09:23:02 +053041 self.calculate_total_net_weight()
Nabin Haite7679702015-02-20 14:40:35 +053042
43 def validate_conversion_rate(self):
Nabin Hait3237c752015-02-17 11:11:11 +053044 # validate conversion rate
Rushabh Mehtacc8b2b22017-03-31 12:44:29 +053045 company_currency = erpnext.get_company_currency(self.doc.company)
Nabin Hait3237c752015-02-17 11:11:11 +053046 if not self.doc.currency or self.doc.currency == company_currency:
47 self.doc.currency = company_currency
48 self.doc.conversion_rate = 1.0
49 else:
50 validate_conversion_rate(self.doc.currency, self.doc.conversion_rate,
51 self.doc.meta.get_label("conversion_rate"), self.doc.company)
52
53 self.doc.conversion_rate = flt(self.doc.conversion_rate)
54
Nabin Hait3237c752015-02-17 11:11:11 +053055 def calculate_item_values(self):
56 if not self.discount_amount_applied:
57 for item in self.doc.get("items"):
58 self.doc.round_floats_in(item)
59
60 if item.discount_percentage == 100:
61 item.rate = 0.0
62 elif not item.rate:
Nabin Haite7679702015-02-20 14:40:35 +053063 item.rate = flt(item.price_list_rate *
64 (1.0 - (item.discount_percentage / 100.0)), item.precision("rate"))
Nabin Hait3237c752015-02-17 11:11:11 +053065
mbauskara52472c2016-03-05 15:10:25 +053066 if item.doctype in ['Quotation Item', 'Sales Order Item', 'Delivery Note Item', 'Sales Invoice Item']:
Shreya Shahbe690ef2017-11-14 17:22:41 +053067 item.rate_with_margin, item.base_rate_with_margin = self.calculate_margin(item)
mbauskar287fe812017-04-10 19:15:57 +053068
Makarand Bauskar0e4c5c92017-05-11 11:40:02 +053069 item.rate = flt(item.rate_with_margin * (1.0 - (item.discount_percentage / 100.0)), item.precision("rate"))\
70 if item.rate_with_margin > 0 else item.rate
mbauskara52472c2016-03-05 15:10:25 +053071
Nabin Haite7679702015-02-20 14:40:35 +053072 item.net_rate = item.rate
73 item.amount = flt(item.rate * item.qty, item.precision("amount"))
74 item.net_amount = item.amount
Nabin Hait3237c752015-02-17 11:11:11 +053075
Nabin Haite7679702015-02-20 14:40:35 +053076 self._set_in_company_currency(item, ["price_list_rate", "rate", "net_rate", "amount", "net_amount"])
Nabin Hait3237c752015-02-17 11:11:11 +053077
Nabin Haite7679702015-02-20 14:40:35 +053078 item.item_tax_amount = 0.0
79
80 def _set_in_company_currency(self, doc, fields):
Nabin Hait3237c752015-02-17 11:11:11 +053081 """set values in base currency"""
Nabin Haite7679702015-02-20 14:40:35 +053082 for f in fields:
83 val = flt(flt(doc.get(f), doc.precision(f)) * self.doc.conversion_rate, doc.precision("base_" + f))
84 doc.set("base_" + f, val)
Nabin Hait3237c752015-02-17 11:11:11 +053085
86 def initialize_taxes(self):
87 for tax in self.doc.get("taxes"):
Nabin Hait86cd4cc2015-02-28 19:11:51 +053088 if not self.discount_amount_applied:
89 validate_taxes_and_charges(tax)
90 validate_inclusive_tax(tax, self.doc)
Nabin Hait613d0812015-02-23 11:58:15 +053091
Nabin Hait3237c752015-02-17 11:11:11 +053092 tax.item_wise_tax_detail = {}
93 tax_fields = ["total", "tax_amount_after_discount_amount",
94 "tax_amount_for_current_item", "grand_total_for_current_item",
95 "tax_fraction_for_current_item", "grand_total_fraction_for_current_item"]
96
Nabin Haitde9c8a92015-02-23 01:06:00 +053097 if tax.charge_type != "Actual" and \
98 not (self.discount_amount_applied and self.doc.apply_discount_on=="Grand Total"):
99 tax_fields.append("tax_amount")
Nabin Hait3237c752015-02-17 11:11:11 +0530100
101 for fieldname in tax_fields:
102 tax.set(fieldname, 0.0)
103
Nabin Hait3237c752015-02-17 11:11:11 +0530104 self.doc.round_floats_in(tax)
105
Nabin Hait3237c752015-02-17 11:11:11 +0530106 def determine_exclusive_rate(self):
Nabin Hait37b047d2015-02-23 16:01:33 +0530107 if not any((cint(tax.included_in_print_rate) for tax in self.doc.get("taxes"))):
108 return
Nabin Hait3237c752015-02-17 11:11:11 +0530109
110 for item in self.doc.get("items"):
111 item_tax_map = self._load_item_tax_rate(item.item_tax_rate)
112 cumulated_tax_fraction = 0
113 for i, tax in enumerate(self.doc.get("taxes")):
114 tax.tax_fraction_for_current_item = self.get_current_tax_fraction(tax, item_tax_map)
115
116 if i==0:
117 tax.grand_total_fraction_for_current_item = 1 + tax.tax_fraction_for_current_item
118 else:
119 tax.grand_total_fraction_for_current_item = \
120 self.doc.get("taxes")[i-1].grand_total_fraction_for_current_item \
121 + tax.tax_fraction_for_current_item
122
123 cumulated_tax_fraction += tax.tax_fraction_for_current_item
124
125 if cumulated_tax_fraction and not self.discount_amount_applied and item.qty:
Nabin Hait2e4de832017-09-19 14:53:16 +0530126 item.net_amount = flt(item.amount / (1 + cumulated_tax_fraction))
Nabin Haite7679702015-02-20 14:40:35 +0530127 item.net_rate = flt(item.net_amount / item.qty, item.precision("net_rate"))
Nabin Hait2e4de832017-09-19 14:53:16 +0530128 item.discount_percentage = flt(item.discount_percentage,
129 item.precision("discount_percentage"))
Nabin Hait3237c752015-02-17 11:11:11 +0530130
Nabin Haite7679702015-02-20 14:40:35 +0530131 self._set_in_company_currency(item, ["net_rate", "net_amount"])
132
Nabin Hait3237c752015-02-17 11:11:11 +0530133 def _load_item_tax_rate(self, item_tax_rate):
134 return json.loads(item_tax_rate) if item_tax_rate else {}
135
136 def get_current_tax_fraction(self, tax, item_tax_map):
137 """
138 Get tax fraction for calculating tax exclusive amount
139 from tax inclusive amount
140 """
141 current_tax_fraction = 0
142
143 if cint(tax.included_in_print_rate):
144 tax_rate = self._get_tax_rate(tax, item_tax_map)
145
146 if tax.charge_type == "On Net Total":
147 current_tax_fraction = tax_rate / 100.0
148
149 elif tax.charge_type == "On Previous Row Amount":
150 current_tax_fraction = (tax_rate / 100.0) * \
151 self.doc.get("taxes")[cint(tax.row_id) - 1].tax_fraction_for_current_item
152
153 elif tax.charge_type == "On Previous Row Total":
154 current_tax_fraction = (tax_rate / 100.0) * \
155 self.doc.get("taxes")[cint(tax.row_id) - 1].grand_total_fraction_for_current_item
156
Nabin Haita6ee8292015-05-15 12:02:01 +0530157 if getattr(tax, "add_deduct_tax", None):
158 current_tax_fraction *= -1.0 if (tax.add_deduct_tax == "Deduct") else 1.0
Nabin Hait3237c752015-02-17 11:11:11 +0530159 return current_tax_fraction
160
161 def _get_tax_rate(self, tax, item_tax_map):
162 if item_tax_map.has_key(tax.account_head):
163 return flt(item_tax_map.get(tax.account_head), self.doc.precision("rate", tax))
164 else:
165 return tax.rate
166
167 def calculate_net_total(self):
Vishal Dhayaguded3770182017-12-14 18:06:02 +0530168 self.doc.total = self.doc.base_total = self.doc.net_total = self.doc.base_net_total = 0.0
Nabin Hait3237c752015-02-17 11:11:11 +0530169 for item in self.doc.get("items"):
Nabin Haitf0bc9b62015-02-23 01:40:01 +0530170 self.doc.total += item.amount
171 self.doc.base_total += item.base_amount
Nabin Haite7679702015-02-20 14:40:35 +0530172 self.doc.net_total += item.net_amount
173 self.doc.base_net_total += item.base_net_amount
Nabin Hait3237c752015-02-17 11:11:11 +0530174
Nabin Haitf0bc9b62015-02-23 01:40:01 +0530175 self.doc.round_floats_in(self.doc, ["total", "base_total", "net_total", "base_net_total"])
Nabin Hait3237c752015-02-17 11:11:11 +0530176
177 def calculate_taxes(self):
Nabin Hait2e4de832017-09-19 14:53:16 +0530178 self.doc.rounding_adjustment = 0
Nabin Hait3237c752015-02-17 11:11:11 +0530179 # maintain actual tax rate based on idx
Nabin Haite7679702015-02-20 14:40:35 +0530180 actual_tax_dict = dict([[tax.idx, flt(tax.tax_amount, tax.precision("tax_amount"))]
Nabin Hait3237c752015-02-17 11:11:11 +0530181 for tax in self.doc.get("taxes") if tax.charge_type == "Actual"])
182
183 for n, item in enumerate(self.doc.get("items")):
184 item_tax_map = self._load_item_tax_rate(item.item_tax_rate)
Nabin Hait3237c752015-02-17 11:11:11 +0530185 for i, tax in enumerate(self.doc.get("taxes")):
186 # tax_amount represents the amount of tax for the current step
187 current_tax_amount = self.get_current_tax_amount(item, tax, item_tax_map)
188
189 # Adjust divisional loss to the last item
190 if tax.charge_type == "Actual":
191 actual_tax_dict[tax.idx] -= current_tax_amount
192 if n == len(self.doc.get("items")) - 1:
193 current_tax_amount += actual_tax_dict[tax.idx]
194
Nabin Hait2b019ed2015-02-22 23:03:07 +0530195 # accumulate tax amount into tax.tax_amount
Nabin Haitde9c8a92015-02-23 01:06:00 +0530196 if tax.charge_type != "Actual" and \
197 not (self.discount_amount_applied and self.doc.apply_discount_on=="Grand Total"):
198 tax.tax_amount += current_tax_amount
Nabin Hait2b019ed2015-02-22 23:03:07 +0530199
Nabin Hait3237c752015-02-17 11:11:11 +0530200 # store tax_amount for current item as it will be used for
201 # charge type = 'On Previous Row Amount'
202 tax.tax_amount_for_current_item = current_tax_amount
203
Nabin Hait2b019ed2015-02-22 23:03:07 +0530204 # set tax after discount
Nabin Hait3237c752015-02-17 11:11:11 +0530205 tax.tax_amount_after_discount_amount += current_tax_amount
206
Nabin Haitcd951342017-07-31 18:07:45 +0530207 current_tax_amount = self.get_tax_amount_if_for_valuation_or_deduction(current_tax_amount, tax)
Nabin Hait3237c752015-02-17 11:11:11 +0530208
Nabin Hait3237c752015-02-17 11:11:11 +0530209 # note: grand_total_for_current_item contains the contribution of
210 # item's amount, previously applied tax and the current tax on that item
211 if i==0:
Nabin Haitcd951342017-07-31 18:07:45 +0530212 tax.grand_total_for_current_item = flt(item.net_amount + current_tax_amount)
Nabin Hait3237c752015-02-17 11:11:11 +0530213 else:
214 tax.grand_total_for_current_item = \
Nabin Haitcd951342017-07-31 18:07:45 +0530215 flt(self.doc.get("taxes")[i-1].grand_total_for_current_item + current_tax_amount)
Nabin Hait3237c752015-02-17 11:11:11 +0530216
217 # set precision in the last item iteration
218 if n == len(self.doc.get("items")) - 1:
219 self.round_off_totals(tax)
Nabin Haitcd951342017-07-31 18:07:45 +0530220 self.set_cumulative_total(i, tax)
221
222 self._set_in_company_currency(tax,
223 ["total", "tax_amount", "tax_amount_after_discount_amount"])
Anand Doshiec5ec602015-03-05 19:31:23 +0530224
Nabin Hait3237c752015-02-17 11:11:11 +0530225 # adjust Discount Amount loss in last tax iteration
Nabin Haitde9c8a92015-02-23 01:06:00 +0530226 if i == (len(self.doc.get("taxes")) - 1) and self.discount_amount_applied \
Nabin Haitdb53a782015-07-31 16:53:13 +0530227 and self.doc.discount_amount and self.doc.apply_discount_on == "Grand Total":
Nabin Hait2e4de832017-09-19 14:53:16 +0530228 self.doc.rounding_adjustment = flt(self.doc.grand_total
229 - flt(self.doc.discount_amount) - tax.total,
230 self.doc.precision("rounding_adjustment"))
Anand Doshiec5ec602015-03-05 19:31:23 +0530231
Nabin Haitcd951342017-07-31 18:07:45 +0530232 def get_tax_amount_if_for_valuation_or_deduction(self, tax_amount, tax):
233 # if just for valuation, do not add the tax amount in total
234 # if tax/charges is for deduction, multiply by -1
235 if getattr(tax, "category", None):
236 tax_amount = 0.0 if (tax.category == "Valuation") else tax_amount
Rushabh Mehta30dc9a12017-11-17 14:31:09 +0530237 if self.doc.doctype in ["Purchase Order", "Purchase Invoice", "Purchase Receipt", "Supplier Quotation"]:
238 tax_amount *= -1.0 if (tax.add_deduct_tax == "Deduct") else 1.0
Nabin Haitcd951342017-07-31 18:07:45 +0530239 return tax_amount
Anand Doshiec5ec602015-03-05 19:31:23 +0530240
Nabin Haitcd951342017-07-31 18:07:45 +0530241 def set_cumulative_total(self, row_idx, tax):
242 tax_amount = tax.tax_amount_after_discount_amount
243 tax_amount = self.get_tax_amount_if_for_valuation_or_deduction(tax_amount, tax)
244
245 if row_idx == 0:
246 tax.total = flt(self.doc.net_total + tax_amount, tax.precision("total"))
247 else:
248 tax.total = flt(self.doc.get("taxes")[row_idx-1].total + tax_amount, tax.precision("total"))
Nabin Hait3237c752015-02-17 11:11:11 +0530249
250 def get_current_tax_amount(self, item, tax, item_tax_map):
251 tax_rate = self._get_tax_rate(tax, item_tax_map)
252 current_tax_amount = 0.0
253
254 if tax.charge_type == "Actual":
255 # distribute the tax amount proportionally to each item row
Nabin Haite7679702015-02-20 14:40:35 +0530256 actual = flt(tax.tax_amount, tax.precision("tax_amount"))
257 current_tax_amount = item.net_amount*actual / self.doc.net_total if self.doc.net_total else 0.0
258
Nabin Hait3237c752015-02-17 11:11:11 +0530259 elif tax.charge_type == "On Net Total":
Nabin Haite7679702015-02-20 14:40:35 +0530260 current_tax_amount = (tax_rate / 100.0) * item.net_amount
Nabin Hait3237c752015-02-17 11:11:11 +0530261 elif tax.charge_type == "On Previous Row Amount":
262 current_tax_amount = (tax_rate / 100.0) * \
263 self.doc.get("taxes")[cint(tax.row_id) - 1].tax_amount_for_current_item
264 elif tax.charge_type == "On Previous Row Total":
265 current_tax_amount = (tax_rate / 100.0) * \
266 self.doc.get("taxes")[cint(tax.row_id) - 1].grand_total_for_current_item
267
Nabin Haite7679702015-02-20 14:40:35 +0530268 self.set_item_wise_tax(item, tax, tax_rate, current_tax_amount)
Nabin Hait3237c752015-02-17 11:11:11 +0530269
270 return current_tax_amount
271
Nabin Haite7679702015-02-20 14:40:35 +0530272 def set_item_wise_tax(self, item, tax, tax_rate, current_tax_amount):
273 # store tax breakup for each item
274 key = item.item_code or item.item_name
275 item_wise_tax_amount = current_tax_amount*self.doc.conversion_rate
276 if tax.item_wise_tax_detail.get(key):
277 item_wise_tax_amount += tax.item_wise_tax_detail[key][1]
278
Nabin Haitcaab5822017-08-24 16:22:28 +0530279 tax.item_wise_tax_detail[key] = [tax_rate,flt(item_wise_tax_amount)]
Nabin Haite7679702015-02-20 14:40:35 +0530280
Nabin Hait3237c752015-02-17 11:11:11 +0530281 def round_off_totals(self, tax):
Nabin Haite7679702015-02-20 14:40:35 +0530282 tax.tax_amount = flt(tax.tax_amount, tax.precision("tax_amount"))
Vishal Dhayaguded42242d2017-11-29 16:09:59 +0530283 tax.tax_amount_after_discount_amount = flt(tax.tax_amount_after_discount_amount,
Nabin Haitcd951342017-07-31 18:07:45 +0530284 tax.precision("tax_amount"))
Nabin Haitce245122015-02-22 20:14:49 +0530285
Nabin Haita1bf43b2015-03-17 10:50:47 +0530286 def manipulate_grand_total_for_inclusive_tax(self):
287 # if fully inclusive taxes and diff
Nabin Hait2e4de832017-09-19 14:53:16 +0530288 if self.doc.get("taxes") and any([cint(t.included_in_print_rate) for t in self.doc.get("taxes")]):
Nabin Haita1bf43b2015-03-17 10:50:47 +0530289 last_tax = self.doc.get("taxes")[-1]
Nabin Hait2e4de832017-09-19 14:53:16 +0530290 non_inclusive_tax_amount = sum([flt(d.tax_amount_after_discount_amount)
291 for d in self.doc.get("taxes") if not d.included_in_print_rate])
292 diff = self.doc.total + non_inclusive_tax_amount \
293 - flt(last_tax.total, last_tax.precision("total"))
294 if diff and abs(diff) <= (5.0 / 10**last_tax.precision("tax_amount")):
295 self.doc.rounding_adjustment = flt(flt(self.doc.rounding_adjustment) +
296 flt(diff), self.doc.precision("rounding_adjustment"))
Nabin Hait3237c752015-02-17 11:11:11 +0530297
298 def calculate_totals(self):
Nabin Hait2e4de832017-09-19 14:53:16 +0530299 self.doc.grand_total = flt(self.doc.get("taxes")[-1].total) + flt(self.doc.rounding_adjustment) \
300 if self.doc.get("taxes") else flt(self.doc.net_total)
Nabin Hait3237c752015-02-17 11:11:11 +0530301
Nabin Hait2e4de832017-09-19 14:53:16 +0530302 self.doc.total_taxes_and_charges = flt(self.doc.grand_total - self.doc.net_total
303 - flt(self.doc.rounding_adjustment), self.doc.precision("total_taxes_and_charges"))
Anand Doshiec5ec602015-03-05 19:31:23 +0530304
Nabin Hait2e4de832017-09-19 14:53:16 +0530305 self._set_in_company_currency(self.doc, ["total_taxes_and_charges", "rounding_adjustment"])
Anand Doshiec5ec602015-03-05 19:31:23 +0530306
Nabin Haitbd00e812015-02-17 12:50:51 +0530307 if self.doc.doctype in ["Quotation", "Sales Order", "Delivery Note", "Sales Invoice"]:
Nabin Haite7679702015-02-20 14:40:35 +0530308 self.doc.base_grand_total = flt(self.doc.grand_total * self.doc.conversion_rate) \
309 if self.doc.total_taxes_and_charges else self.doc.base_net_total
Nabin Hait3237c752015-02-17 11:11:11 +0530310 else:
Anand Doshiec5ec602015-03-05 19:31:23 +0530311 self.doc.taxes_and_charges_added = self.doc.taxes_and_charges_deducted = 0.0
Nabin Hait3237c752015-02-17 11:11:11 +0530312 for tax in self.doc.get("taxes"):
313 if tax.category in ["Valuation and Total", "Total"]:
314 if tax.add_deduct_tax == "Add":
Nabin Haitdb53a782015-07-31 16:53:13 +0530315 self.doc.taxes_and_charges_added += flt(tax.tax_amount_after_discount_amount)
Nabin Hait3237c752015-02-17 11:11:11 +0530316 else:
Nabin Haitdb53a782015-07-31 16:53:13 +0530317 self.doc.taxes_and_charges_deducted += flt(tax.tax_amount_after_discount_amount)
Nabin Hait3237c752015-02-17 11:11:11 +0530318
Nabin Haite7679702015-02-20 14:40:35 +0530319 self.doc.round_floats_in(self.doc, ["taxes_and_charges_added", "taxes_and_charges_deducted"])
Nabin Hait3237c752015-02-17 11:11:11 +0530320
Nabin Haite7679702015-02-20 14:40:35 +0530321 self.doc.base_grand_total = flt(self.doc.grand_total * self.doc.conversion_rate) \
322 if (self.doc.taxes_and_charges_added or self.doc.taxes_and_charges_deducted) \
323 else self.doc.base_net_total
Nabin Hait3237c752015-02-17 11:11:11 +0530324
Nabin Hait2e4de832017-09-19 14:53:16 +0530325 self._set_in_company_currency(self.doc,
326 ["taxes_and_charges_added", "taxes_and_charges_deducted"])
Nabin Hait3237c752015-02-17 11:11:11 +0530327
Nabin Haite7679702015-02-20 14:40:35 +0530328 self.doc.round_floats_in(self.doc, ["grand_total", "base_grand_total"])
Nabin Hait3237c752015-02-17 11:11:11 +0530329
Nabin Hait2e4de832017-09-19 14:53:16 +0530330 self.set_rounded_total()
331
rohitwaghchaurea8fb2db2018-05-26 09:23:02 +0530332 def calculate_total_net_weight(self):
333 if self.doc.meta.get_field('total_net_weight'):
334 self.doc.total_net_weight = 0.0
335 for d in self.doc.items:
336 if d.total_weight:
337 self.doc.total_net_weight += d.total_weight
338
Nabin Hait2e4de832017-09-19 14:53:16 +0530339 def set_rounded_total(self):
Nabin Hait3237c752015-02-17 11:11:11 +0530340 if self.doc.meta.get_field("rounded_total"):
Nabin Hait877e1bb2017-11-17 12:27:43 +0530341 if self.doc.is_rounded_total_disabled():
342 self.doc.rounded_total = self.doc.base_rounded_total = 0
343 return
344
Anand Doshi15f7b1e2016-04-04 15:03:28 +0530345 self.doc.rounded_total = round_based_on_smallest_currency_fraction(self.doc.grand_total,
Nabin Haitfb0b24a2016-01-20 14:46:26 +0530346 self.doc.currency, self.doc.precision("rounded_total"))
Nabin Hait2e4de832017-09-19 14:53:16 +0530347
Nabin Hait877e1bb2017-11-17 12:27:43 +0530348 #if print_in_rate is set, we would have already calculated rounding adjustment
349 self.doc.rounding_adjustment += flt(self.doc.rounded_total - self.doc.grand_total,
350 self.doc.precision("rounding_adjustment"))
351
Nabin Hait02ac9012017-11-22 16:12:20 +0530352 self._set_in_company_currency(self.doc, ["rounding_adjustment", "rounded_total"])
Nabin Hait877e1bb2017-11-17 12:27:43 +0530353
Nabin Hait3237c752015-02-17 11:11:11 +0530354 def _cleanup(self):
355 for tax in self.doc.get("taxes"):
356 tax.item_wise_tax_detail = json.dumps(tax.item_wise_tax_detail, separators=(',', ':'))
Anand Doshi15f7b1e2016-04-04 15:03:28 +0530357
Nabin Hait3769d872015-12-18 13:12:02 +0530358 def set_discount_amount(self):
Nabin Haite0405102016-10-13 12:14:32 +0530359 if self.doc.additional_discount_percentage:
Anand Doshi15f7b1e2016-04-04 15:03:28 +0530360 self.doc.discount_amount = flt(flt(self.doc.get(scrub(self.doc.apply_discount_on)))
Nabin Hait3769d872015-12-18 13:12:02 +0530361 * self.doc.additional_discount_percentage / 100, self.doc.precision("discount_amount"))
Nabin Hait3237c752015-02-17 11:11:11 +0530362
363 def apply_discount_amount(self):
364 if self.doc.discount_amount:
Nabin Hait37b047d2015-02-23 16:01:33 +0530365 if not self.doc.apply_discount_on:
366 frappe.throw(_("Please select Apply Discount On"))
367
Nabin Hait3237c752015-02-17 11:11:11 +0530368 self.doc.base_discount_amount = flt(self.doc.discount_amount * self.doc.conversion_rate,
369 self.doc.precision("base_discount_amount"))
370
Nabin Haite7679702015-02-20 14:40:35 +0530371 total_for_discount_amount = self.get_total_for_discount_amount()
Nabin Hait25bd84d2015-03-04 15:06:56 +0530372 taxes = self.doc.get("taxes")
373 net_total = 0
Nabin Hait3237c752015-02-17 11:11:11 +0530374
Nabin Haite7679702015-02-20 14:40:35 +0530375 if total_for_discount_amount:
Nabin Hait3237c752015-02-17 11:11:11 +0530376 # calculate item amount after Discount Amount
Nabin Hait25bd84d2015-03-04 15:06:56 +0530377 for i, item in enumerate(self.doc.get("items")):
378 distributed_amount = flt(self.doc.discount_amount) * \
379 item.net_amount / total_for_discount_amount
Anand Doshiec5ec602015-03-05 19:31:23 +0530380
Nabin Haite7679702015-02-20 14:40:35 +0530381 item.net_amount = flt(item.net_amount - distributed_amount, item.precision("net_amount"))
Nabin Hait25bd84d2015-03-04 15:06:56 +0530382 net_total += item.net_amount
Anand Doshiec5ec602015-03-05 19:31:23 +0530383
Nabin Hait25bd84d2015-03-04 15:06:56 +0530384 # discount amount rounding loss adjustment if no taxes
385 if (not taxes or self.doc.apply_discount_on == "Net Total") \
386 and i == len(self.doc.get("items")) - 1:
Rushabh Mehtac6bd7ad2016-12-21 17:30:29 +0530387 discount_amount_loss = flt(self.doc.net_total - net_total - self.doc.discount_amount,
Nabin Hait25bd84d2015-03-04 15:06:56 +0530388 self.doc.precision("net_total"))
Rushabh Mehtac6bd7ad2016-12-21 17:30:29 +0530389
Anand Doshiec5ec602015-03-05 19:31:23 +0530390 item.net_amount = flt(item.net_amount + discount_amount_loss,
Nabin Hait25bd84d2015-03-04 15:06:56 +0530391 item.precision("net_amount"))
Anand Doshiec5ec602015-03-05 19:31:23 +0530392
Nabin Hait51e980d2015-10-10 18:10:05 +0530393 item.net_rate = flt(item.net_amount / item.qty, item.precision("net_rate")) if item.qty else 0
Anand Doshiec5ec602015-03-05 19:31:23 +0530394
Nabin Haite7679702015-02-20 14:40:35 +0530395 self._set_in_company_currency(item, ["net_rate", "net_amount"])
Nabin Hait3237c752015-02-17 11:11:11 +0530396
397 self.discount_amount_applied = True
398 self._calculate()
399 else:
400 self.doc.base_discount_amount = 0
401
Nabin Haite7679702015-02-20 14:40:35 +0530402 def get_total_for_discount_amount(self):
Nabin Haitde9c8a92015-02-23 01:06:00 +0530403 if self.doc.apply_discount_on == "Net Total":
404 return self.doc.net_total
Nabin Haite7679702015-02-20 14:40:35 +0530405 else:
406 actual_taxes_dict = {}
Nabin Hait3237c752015-02-17 11:11:11 +0530407
Nabin Haite7679702015-02-20 14:40:35 +0530408 for tax in self.doc.get("taxes"):
409 if tax.charge_type == "Actual":
Nabin Haitaf9bdfe2017-12-12 18:50:05 +0530410 tax_amount = self.get_tax_amount_if_for_valuation_or_deduction(tax.tax_amount, tax)
411 actual_taxes_dict.setdefault(tax.idx, tax_amount)
Nabin Haite7679702015-02-20 14:40:35 +0530412 elif tax.row_id in actual_taxes_dict:
413 actual_tax_amount = flt(actual_taxes_dict.get(tax.row_id, 0)) * flt(tax.rate) / 100
414 actual_taxes_dict.setdefault(tax.idx, actual_tax_amount)
Nabin Hait3237c752015-02-17 11:11:11 +0530415
Nabin Hait877e1bb2017-11-17 12:27:43 +0530416 return flt(self.doc.grand_total - sum(actual_taxes_dict.values()),
417 self.doc.precision("grand_total"))
Nabin Hait3237c752015-02-17 11:11:11 +0530418
419
Nabin Hait7b19b9e2015-02-24 09:42:24 +0530420 def calculate_total_advance(self):
421 if self.doc.docstatus < 2:
Nabin Haite7679702015-02-20 14:40:35 +0530422 total_allocated_amount = sum([flt(adv.allocated_amount, adv.precision("allocated_amount"))
Nabin Hait3237c752015-02-17 11:11:11 +0530423 for adv in self.doc.get("advances")])
424
Nabin Haite7679702015-02-20 14:40:35 +0530425 self.doc.total_advance = flt(total_allocated_amount, self.doc.precision("total_advance"))
Anand Doshi15f7b1e2016-04-04 15:03:28 +0530426
Faris Ansari6041f5c2018-02-08 13:33:52 +0530427 grand_total = self.doc.rounded_total or self.doc.grand_total
428
Nabin Hait289ffb72016-02-08 11:06:55 +0530429 if self.doc.party_account_currency == self.doc.currency:
Faris Ansari6041f5c2018-02-08 13:33:52 +0530430 invoice_total = flt(grand_total - flt(self.doc.write_off_amount),
Nabin Hait289ffb72016-02-08 11:06:55 +0530431 self.doc.precision("grand_total"))
Nabin Hait8d8cba72017-04-03 17:26:22 +0530432 else:
Vishal Dhayaguded42242d2017-11-29 16:09:59 +0530433 base_write_off_amount = flt(flt(self.doc.write_off_amount) * self.doc.conversion_rate,
Nabin Hait8d8cba72017-04-03 17:26:22 +0530434 self.doc.precision("base_write_off_amount"))
Faris Ansari6041f5c2018-02-08 13:33:52 +0530435 invoice_total = flt(grand_total * self.doc.conversion_rate,
Nabin Hait8d8cba72017-04-03 17:26:22 +0530436 self.doc.precision("grand_total")) - base_write_off_amount
Vishal Dhayaguded42242d2017-11-29 16:09:59 +0530437
Nabin Haitadc09232016-02-09 10:31:11 +0530438 if invoice_total > 0 and self.doc.total_advance > invoice_total:
Nabin Hait289ffb72016-02-08 11:06:55 +0530439 frappe.throw(_("Advance amount cannot be greater than {0} {1}")
440 .format(self.doc.party_account_currency, invoice_total))
Nabin Hait3237c752015-02-17 11:11:11 +0530441
Rushabh Mehta8bb6e532015-02-18 20:22:59 +0530442 if self.doc.docstatus == 0:
Nabin Hait3237c752015-02-17 11:11:11 +0530443 self.calculate_outstanding_amount()
444
445 def calculate_outstanding_amount(self):
446 # NOTE:
447 # write_off_amount is only for POS Invoice
448 # total_advance is only for non POS Invoice
Rohit Waghchaureefb5bf22016-08-25 02:09:53 +0530449 if self.doc.doctype == "Sales Invoice":
450 self.calculate_paid_amount()
451
452 if self.doc.is_return: return
Anand Doshi15f7b1e2016-04-04 15:03:28 +0530453
Nabin Hait4ffd7f32015-08-27 12:28:36 +0530454 self.doc.round_floats_in(self.doc, ["grand_total", "total_advance", "write_off_amount"])
Anand Doshi15f7b1e2016-04-04 15:03:28 +0530455 self._set_in_company_currency(self.doc, ['write_off_amount'])
456
Nabin Hait877e1bb2017-11-17 12:27:43 +0530457 if self.doc.doctype in ["Sales Invoice", "Purchase Invoice"]:
458 grand_total = self.doc.rounded_total or self.doc.grand_total
459 if self.doc.party_account_currency == self.doc.currency:
460 total_amount_to_pay = flt(grand_total - self.doc.total_advance
461 - flt(self.doc.write_off_amount), self.doc.precision("grand_total"))
462 else:
463 total_amount_to_pay = flt(flt(grand_total *
464 self.doc.conversion_rate, self.doc.precision("grand_total")) - self.doc.total_advance
465 - flt(self.doc.base_write_off_amount), self.doc.precision("grand_total"))
Anand Doshi15f7b1e2016-04-04 15:03:28 +0530466
Nabin Hait4ffd7f32015-08-27 12:28:36 +0530467 self.doc.round_floats_in(self.doc, ["paid_amount"])
Nabin Hait877e1bb2017-11-17 12:27:43 +0530468 change_amount = 0
469
470 if self.doc.doctype == "Sales Invoice":
471 self.calculate_write_off_amount()
472 self.calculate_change_amount()
473 change_amount = self.doc.change_amount \
474 if self.doc.party_account_currency == self.doc.currency else self.doc.base_change_amount
475
Nabin Haitac3b2aa2017-05-30 15:35:01 +0530476 paid_amount = self.doc.paid_amount \
477 if self.doc.party_account_currency == self.doc.currency else self.doc.base_paid_amount
Rohit Waghchaure6087fe12016-04-09 14:31:09 +0530478
Rohit Waghchaure609e2b42016-08-31 02:04:37 +0530479
Nabin Hait877e1bb2017-11-17 12:27:43 +0530480 self.doc.outstanding_amount = flt(total_amount_to_pay - flt(paid_amount) + flt(change_amount),
481 self.doc.precision("outstanding_amount"))
Rushabh Mehtac6bd7ad2016-12-21 17:30:29 +0530482
Rohit Waghchaure6087fe12016-04-09 14:31:09 +0530483 def calculate_paid_amount(self):
484 paid_amount = base_paid_amount = 0.0
Rohit Waghchauref58cad62017-01-17 12:11:57 +0530485
486 if self.doc.is_pos:
487 for payment in self.doc.get('payments'):
Ayush Shuklae9cf1ab2017-05-25 14:14:55 +0530488 payment.amount = flt(payment.amount)
489 payment.base_amount = payment.amount * flt(self.doc.conversion_rate)
Rohit Waghchauref58cad62017-01-17 12:11:57 +0530490 paid_amount += payment.amount
491 base_paid_amount += payment.base_amount
rohitwaghchaure73456ac2017-05-16 11:29:57 +0530492 elif not self.doc.is_return:
493 self.doc.set('payments', [])
Rohit Waghchaure6087fe12016-04-09 14:31:09 +0530494
495 self.doc.paid_amount = flt(paid_amount, self.doc.precision("paid_amount"))
496 self.doc.base_paid_amount = flt(base_paid_amount, self.doc.precision("base_paid_amount"))
497
Nabin Hait3bb1a422016-08-02 16:41:10 +0530498 def calculate_change_amount(self):
499 self.doc.change_amount = 0.0
Rohit Waghchaure609e2b42016-08-31 02:04:37 +0530500 self.doc.base_change_amount = 0.0
Nabin Hait877e1bb2017-11-17 12:27:43 +0530501
502 if self.doc.doctype == "Sales Invoice" \
503 and self.doc.paid_amount > self.doc.grand_total and not self.doc.is_return \
Nabin Haitac3b2aa2017-05-30 15:35:01 +0530504 and any([d.type == "Cash" for d in self.doc.payments]):
Rohit Waghchauree8d22bb2018-02-05 18:13:29 +0530505 grand_total = self.doc.rounded_total or self.doc.grand_total
506 base_grand_total = self.doc.base_rounded_total or self.doc.base_grand_total
Nabin Haitac3b2aa2017-05-30 15:35:01 +0530507
Rohit Waghchauree8d22bb2018-02-05 18:13:29 +0530508 self.doc.change_amount = flt(self.doc.paid_amount - grand_total +
Nabin Hait3bb1a422016-08-02 16:41:10 +0530509 self.doc.write_off_amount, self.doc.precision("change_amount"))
Rohit Waghchaure6087fe12016-04-09 14:31:09 +0530510
Rohit Waghchauree8d22bb2018-02-05 18:13:29 +0530511 self.doc.base_change_amount = flt(self.doc.base_paid_amount - base_grand_total +
Rohit Waghchaure609e2b42016-08-31 02:04:37 +0530512 self.doc.base_write_off_amount, self.doc.precision("base_change_amount"))
mbauskar36b51892016-01-18 16:31:10 +0530513
Rohit Waghchaure7127a8f2016-08-04 14:56:15 +0530514 def calculate_write_off_amount(self):
Rohit Waghchaurebaef2622016-08-05 15:41:36 +0530515 if flt(self.doc.change_amount) > 0:
Nabin Hait877e1bb2017-11-17 12:27:43 +0530516 self.doc.write_off_amount = flt(self.doc.grand_total - self.doc.paid_amount
517 + self.doc.change_amount, self.doc.precision("write_off_amount"))
Rohit Waghchaurebaef2622016-08-05 15:41:36 +0530518 self.doc.base_write_off_amount = flt(self.doc.write_off_amount * self.doc.conversion_rate,
519 self.doc.precision("base_write_off_amount"))
Rohit Waghchaure7127a8f2016-08-04 14:56:15 +0530520
mbauskar36b51892016-01-18 16:31:10 +0530521 def calculate_margin(self, item):
Makarand Bauskar0e4c5c92017-05-11 11:40:02 +0530522 rate_with_margin = 0.0
Shreya Shahbe690ef2017-11-14 17:22:41 +0530523 base_rate_with_margin = 0.0
mbauskar36b51892016-01-18 16:31:10 +0530524 if item.price_list_rate:
Rushabh Mehtac6bd7ad2016-12-21 17:30:29 +0530525 if item.pricing_rule and not self.doc.ignore_pricing_rule:
mbauskar36b51892016-01-18 16:31:10 +0530526 pricing_rule = frappe.get_doc('Pricing Rule', item.pricing_rule)
mbauskara52472c2016-03-05 15:10:25 +0530527 item.margin_type = pricing_rule.margin_type
528 item.margin_rate_or_amount = pricing_rule.margin_rate_or_amount
mbauskar36b51892016-01-18 16:31:10 +0530529
mbauskara52472c2016-03-05 15:10:25 +0530530 if item.margin_type and item.margin_rate_or_amount:
531 margin_value = item.margin_rate_or_amount if item.margin_type == 'Amount' else flt(item.price_list_rate) * flt(item.margin_rate_or_amount) / 100
Makarand Bauskar0e4c5c92017-05-11 11:40:02 +0530532 rate_with_margin = flt(item.price_list_rate) + flt(margin_value)
Shreya Shahbe690ef2017-11-14 17:22:41 +0530533 base_rate_with_margin = flt(rate_with_margin) * flt(self.doc.conversion_rate)
mbauskar36b51892016-01-18 16:31:10 +0530534
Shreya Shahbe690ef2017-11-14 17:22:41 +0530535 return rate_with_margin, base_rate_with_margin
Nabin Hait852cb642017-07-05 12:58:19 +0530536
537 def set_item_wise_tax_breakup(self):
Nabin Hait9c421612017-07-20 13:32:01 +0530538 self.doc.other_charges_calculation = get_itemised_tax_breakup_html(self.doc)
Vishal Dhayaguded42242d2017-11-29 16:09:59 +0530539
Nabin Hait9c421612017-07-20 13:32:01 +0530540def get_itemised_tax_breakup_html(doc):
541 if not doc.taxes:
542 return
543 frappe.flags.company = doc.company
Vishal Dhayaguded42242d2017-11-29 16:09:59 +0530544
Nabin Hait9c421612017-07-20 13:32:01 +0530545 # get headers
Nabin Haitcaab5822017-08-24 16:22:28 +0530546 tax_accounts = []
547 for tax in doc.taxes:
548 if getattr(tax, "category", None) and tax.category=="Valuation":
549 continue
rohitwaghchaure4e17fae2017-12-12 14:40:52 +0530550 if tax.description not in tax_accounts:
Nabin Haitcaab5822017-08-24 16:22:28 +0530551 tax_accounts.append(tax.description)
552
Nabin Hait9c421612017-07-20 13:32:01 +0530553 headers = get_itemised_tax_breakup_header(doc.doctype + " Item", tax_accounts)
Vishal Dhayaguded42242d2017-11-29 16:09:59 +0530554
Nabin Hait9c421612017-07-20 13:32:01 +0530555 # get tax breakup data
556 itemised_tax, itemised_taxable_amount = get_itemised_tax_breakup_data(doc)
Nabin Haitcaab5822017-08-24 16:22:28 +0530557
558 get_rounded_tax_amount(itemised_tax, doc.precision("tax_amount", "taxes"))
559
rohitwaghchaured4526682017-12-28 14:20:13 +0530560 update_itemised_tax_data(doc)
Nabin Hait9c421612017-07-20 13:32:01 +0530561 frappe.flags.company = None
Vishal Dhayaguded42242d2017-11-29 16:09:59 +0530562
Nabin Hait9c421612017-07-20 13:32:01 +0530563 return frappe.render_template(
564 "templates/includes/itemised_tax_breakup.html", dict(
565 headers=headers,
566 itemised_tax=itemised_tax,
567 itemised_taxable_amount=itemised_taxable_amount,
568 tax_accounts=tax_accounts,
Faris Ansari69b05352018-05-14 14:19:31 +0530569 conversion_rate=doc.conversion_rate,
570 currency=doc.currency
Nabin Haitb962fc12017-07-17 18:02:31 +0530571 )
Nabin Hait9c421612017-07-20 13:32:01 +0530572 )
Nabin Hait852cb642017-07-05 12:58:19 +0530573
rohitwaghchaured4526682017-12-28 14:20:13 +0530574
575@erpnext.allow_regional
576def update_itemised_tax_data(doc):
577 #Don't delete this method, used for localization
578 pass
579
Nabin Haitb962fc12017-07-17 18:02:31 +0530580@erpnext.allow_regional
581def get_itemised_tax_breakup_header(item_doctype, tax_accounts):
582 return [_("Item"), _("Taxable Amount")] + tax_accounts
583
584@erpnext.allow_regional
585def get_itemised_tax_breakup_data(doc):
586 itemised_tax = get_itemised_tax(doc.taxes)
587
588 itemised_taxable_amount = get_itemised_taxable_amount(doc.items)
589
590 return itemised_tax, itemised_taxable_amount
591
592def get_itemised_tax(taxes):
593 itemised_tax = {}
594 for tax in taxes:
Nabin Haitcaab5822017-08-24 16:22:28 +0530595 if getattr(tax, "category", None) and tax.category=="Valuation":
596 continue
597
Nabin Haitb962fc12017-07-17 18:02:31 +0530598 item_tax_map = json.loads(tax.item_wise_tax_detail) if tax.item_wise_tax_detail else {}
Nabin Hait2e4de832017-09-19 14:53:16 +0530599 if item_tax_map:
600 for item_code, tax_data in item_tax_map.items():
601 itemised_tax.setdefault(item_code, frappe._dict())
Vishal Dhayaguded42242d2017-11-29 16:09:59 +0530602
Nabin Hait2e4de832017-09-19 14:53:16 +0530603 if isinstance(tax_data, list):
604 itemised_tax[item_code][tax.description] = frappe._dict(dict(
605 tax_rate=flt(tax_data[0]),
606 tax_amount=flt(tax_data[1])
607 ))
608 else:
609 itemised_tax[item_code][tax.description] = frappe._dict(dict(
610 tax_rate=flt(tax_data),
611 tax_amount=0.0
612 ))
Rohit Waghchaure296fbfe2017-07-10 13:03:29 +0530613
Nabin Haitb962fc12017-07-17 18:02:31 +0530614 return itemised_tax
615
616def get_itemised_taxable_amount(items):
617 itemised_taxable_amount = frappe._dict()
618 for item in items:
Rohit Waghchaure296fbfe2017-07-10 13:03:29 +0530619 item_code = item.item_code or item.item_name
Nabin Haitb962fc12017-07-17 18:02:31 +0530620 itemised_taxable_amount.setdefault(item_code, 0)
621 itemised_taxable_amount[item_code] += item.net_amount
622
Nabin Haitcaab5822017-08-24 16:22:28 +0530623 return itemised_taxable_amount
624
625def get_rounded_tax_amount(itemised_tax, precision):
626 # Rounding based on tax_amount precision
627 for taxes in itemised_tax.values():
628 for tax_account in taxes:
629 taxes[tax_account]["tax_amount"] = flt(taxes[tax_account]["tax_amount"], precision)