blob: 6c0347f7a07e71603f21e52ed76a4262945c08d3 [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):
Achilles Rasquinha87dab142018-03-08 14:21:48 +0530162 if tax.account_head in item_tax_map:
Nabin Hait3237c752015-02-17 11:11:11 +0530163 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):
Shreya Shahe3290382018-05-28 11:49:08 +0530168 self.doc.total_qty = 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
Shreya Shahe3290382018-05-28 11:49:08 +0530171 self.doc.total_qty += item.qty
Nabin Haitf0bc9b62015-02-23 01:40:01 +0530172 self.doc.base_total += item.base_amount
Nabin Haite7679702015-02-20 14:40:35 +0530173 self.doc.net_total += item.net_amount
174 self.doc.base_net_total += item.base_net_amount
Nabin Hait3237c752015-02-17 11:11:11 +0530175
Nabin Haitf0bc9b62015-02-23 01:40:01 +0530176 self.doc.round_floats_in(self.doc, ["total", "base_total", "net_total", "base_net_total"])
Nabin Hait3237c752015-02-17 11:11:11 +0530177
178 def calculate_taxes(self):
Nabin Hait2e4de832017-09-19 14:53:16 +0530179 self.doc.rounding_adjustment = 0
Nabin Hait3237c752015-02-17 11:11:11 +0530180 # maintain actual tax rate based on idx
Nabin Haite7679702015-02-20 14:40:35 +0530181 actual_tax_dict = dict([[tax.idx, flt(tax.tax_amount, tax.precision("tax_amount"))]
Nabin Hait3237c752015-02-17 11:11:11 +0530182 for tax in self.doc.get("taxes") if tax.charge_type == "Actual"])
183
184 for n, item in enumerate(self.doc.get("items")):
185 item_tax_map = self._load_item_tax_rate(item.item_tax_rate)
Nabin Hait3237c752015-02-17 11:11:11 +0530186 for i, tax in enumerate(self.doc.get("taxes")):
187 # tax_amount represents the amount of tax for the current step
188 current_tax_amount = self.get_current_tax_amount(item, tax, item_tax_map)
189
190 # Adjust divisional loss to the last item
191 if tax.charge_type == "Actual":
192 actual_tax_dict[tax.idx] -= current_tax_amount
193 if n == len(self.doc.get("items")) - 1:
194 current_tax_amount += actual_tax_dict[tax.idx]
195
Nabin Hait2b019ed2015-02-22 23:03:07 +0530196 # accumulate tax amount into tax.tax_amount
Nabin Haitde9c8a92015-02-23 01:06:00 +0530197 if tax.charge_type != "Actual" and \
198 not (self.discount_amount_applied and self.doc.apply_discount_on=="Grand Total"):
199 tax.tax_amount += current_tax_amount
Nabin Hait2b019ed2015-02-22 23:03:07 +0530200
Nabin Hait3237c752015-02-17 11:11:11 +0530201 # store tax_amount for current item as it will be used for
202 # charge type = 'On Previous Row Amount'
203 tax.tax_amount_for_current_item = current_tax_amount
204
Nabin Hait2b019ed2015-02-22 23:03:07 +0530205 # set tax after discount
Nabin Hait3237c752015-02-17 11:11:11 +0530206 tax.tax_amount_after_discount_amount += current_tax_amount
207
Nabin Haitcd951342017-07-31 18:07:45 +0530208 current_tax_amount = self.get_tax_amount_if_for_valuation_or_deduction(current_tax_amount, tax)
Nabin Hait3237c752015-02-17 11:11:11 +0530209
Nabin Hait3237c752015-02-17 11:11:11 +0530210 # note: grand_total_for_current_item contains the contribution of
211 # item's amount, previously applied tax and the current tax on that item
212 if i==0:
Nabin Haitcd951342017-07-31 18:07:45 +0530213 tax.grand_total_for_current_item = flt(item.net_amount + current_tax_amount)
Nabin Hait3237c752015-02-17 11:11:11 +0530214 else:
215 tax.grand_total_for_current_item = \
Nabin Haitcd951342017-07-31 18:07:45 +0530216 flt(self.doc.get("taxes")[i-1].grand_total_for_current_item + current_tax_amount)
Nabin Hait3237c752015-02-17 11:11:11 +0530217
218 # set precision in the last item iteration
219 if n == len(self.doc.get("items")) - 1:
220 self.round_off_totals(tax)
Nabin Haitcd951342017-07-31 18:07:45 +0530221 self.set_cumulative_total(i, tax)
222
223 self._set_in_company_currency(tax,
224 ["total", "tax_amount", "tax_amount_after_discount_amount"])
Anand Doshiec5ec602015-03-05 19:31:23 +0530225
Nabin Hait3237c752015-02-17 11:11:11 +0530226 # adjust Discount Amount loss in last tax iteration
Nabin Haitde9c8a92015-02-23 01:06:00 +0530227 if i == (len(self.doc.get("taxes")) - 1) and self.discount_amount_applied \
Nabin Haitdb53a782015-07-31 16:53:13 +0530228 and self.doc.discount_amount and self.doc.apply_discount_on == "Grand Total":
Nabin Hait2e4de832017-09-19 14:53:16 +0530229 self.doc.rounding_adjustment = flt(self.doc.grand_total
230 - flt(self.doc.discount_amount) - tax.total,
231 self.doc.precision("rounding_adjustment"))
Anand Doshiec5ec602015-03-05 19:31:23 +0530232
Nabin Haitcd951342017-07-31 18:07:45 +0530233 def get_tax_amount_if_for_valuation_or_deduction(self, tax_amount, tax):
234 # if just for valuation, do not add the tax amount in total
235 # if tax/charges is for deduction, multiply by -1
236 if getattr(tax, "category", None):
237 tax_amount = 0.0 if (tax.category == "Valuation") else tax_amount
Rushabh Mehta30dc9a12017-11-17 14:31:09 +0530238 if self.doc.doctype in ["Purchase Order", "Purchase Invoice", "Purchase Receipt", "Supplier Quotation"]:
239 tax_amount *= -1.0 if (tax.add_deduct_tax == "Deduct") else 1.0
Nabin Haitcd951342017-07-31 18:07:45 +0530240 return tax_amount
Anand Doshiec5ec602015-03-05 19:31:23 +0530241
Nabin Haitcd951342017-07-31 18:07:45 +0530242 def set_cumulative_total(self, row_idx, tax):
243 tax_amount = tax.tax_amount_after_discount_amount
244 tax_amount = self.get_tax_amount_if_for_valuation_or_deduction(tax_amount, tax)
245
246 if row_idx == 0:
247 tax.total = flt(self.doc.net_total + tax_amount, tax.precision("total"))
248 else:
249 tax.total = flt(self.doc.get("taxes")[row_idx-1].total + tax_amount, tax.precision("total"))
Nabin Hait3237c752015-02-17 11:11:11 +0530250
251 def get_current_tax_amount(self, item, tax, item_tax_map):
252 tax_rate = self._get_tax_rate(tax, item_tax_map)
253 current_tax_amount = 0.0
254
255 if tax.charge_type == "Actual":
256 # distribute the tax amount proportionally to each item row
Nabin Haite7679702015-02-20 14:40:35 +0530257 actual = flt(tax.tax_amount, tax.precision("tax_amount"))
258 current_tax_amount = item.net_amount*actual / self.doc.net_total if self.doc.net_total else 0.0
259
Nabin Hait3237c752015-02-17 11:11:11 +0530260 elif tax.charge_type == "On Net Total":
Nabin Haite7679702015-02-20 14:40:35 +0530261 current_tax_amount = (tax_rate / 100.0) * item.net_amount
Nabin Hait3237c752015-02-17 11:11:11 +0530262 elif tax.charge_type == "On Previous Row Amount":
263 current_tax_amount = (tax_rate / 100.0) * \
264 self.doc.get("taxes")[cint(tax.row_id) - 1].tax_amount_for_current_item
265 elif tax.charge_type == "On Previous Row Total":
266 current_tax_amount = (tax_rate / 100.0) * \
267 self.doc.get("taxes")[cint(tax.row_id) - 1].grand_total_for_current_item
268
Nabin Haite7679702015-02-20 14:40:35 +0530269 self.set_item_wise_tax(item, tax, tax_rate, current_tax_amount)
Nabin Hait3237c752015-02-17 11:11:11 +0530270
271 return current_tax_amount
272
Nabin Haite7679702015-02-20 14:40:35 +0530273 def set_item_wise_tax(self, item, tax, tax_rate, current_tax_amount):
274 # store tax breakup for each item
275 key = item.item_code or item.item_name
276 item_wise_tax_amount = current_tax_amount*self.doc.conversion_rate
277 if tax.item_wise_tax_detail.get(key):
278 item_wise_tax_amount += tax.item_wise_tax_detail[key][1]
279
Nabin Haitcaab5822017-08-24 16:22:28 +0530280 tax.item_wise_tax_detail[key] = [tax_rate,flt(item_wise_tax_amount)]
Nabin Haite7679702015-02-20 14:40:35 +0530281
Nabin Hait3237c752015-02-17 11:11:11 +0530282 def round_off_totals(self, tax):
Nabin Haite7679702015-02-20 14:40:35 +0530283 tax.tax_amount = flt(tax.tax_amount, tax.precision("tax_amount"))
Vishal Dhayaguded42242d2017-11-29 16:09:59 +0530284 tax.tax_amount_after_discount_amount = flt(tax.tax_amount_after_discount_amount,
Nabin Haitcd951342017-07-31 18:07:45 +0530285 tax.precision("tax_amount"))
Nabin Haitce245122015-02-22 20:14:49 +0530286
Nabin Haita1bf43b2015-03-17 10:50:47 +0530287 def manipulate_grand_total_for_inclusive_tax(self):
288 # if fully inclusive taxes and diff
Nabin Hait2e4de832017-09-19 14:53:16 +0530289 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 +0530290 last_tax = self.doc.get("taxes")[-1]
Nabin Hait2e4de832017-09-19 14:53:16 +0530291 non_inclusive_tax_amount = sum([flt(d.tax_amount_after_discount_amount)
292 for d in self.doc.get("taxes") if not d.included_in_print_rate])
293 diff = self.doc.total + non_inclusive_tax_amount \
294 - flt(last_tax.total, last_tax.precision("total"))
295 if diff and abs(diff) <= (5.0 / 10**last_tax.precision("tax_amount")):
296 self.doc.rounding_adjustment = flt(flt(self.doc.rounding_adjustment) +
297 flt(diff), self.doc.precision("rounding_adjustment"))
Nabin Hait3237c752015-02-17 11:11:11 +0530298
299 def calculate_totals(self):
Nabin Hait2e4de832017-09-19 14:53:16 +0530300 self.doc.grand_total = flt(self.doc.get("taxes")[-1].total) + flt(self.doc.rounding_adjustment) \
301 if self.doc.get("taxes") else flt(self.doc.net_total)
Nabin Hait3237c752015-02-17 11:11:11 +0530302
Nabin Hait2e4de832017-09-19 14:53:16 +0530303 self.doc.total_taxes_and_charges = flt(self.doc.grand_total - self.doc.net_total
304 - flt(self.doc.rounding_adjustment), self.doc.precision("total_taxes_and_charges"))
Anand Doshiec5ec602015-03-05 19:31:23 +0530305
Nabin Hait2e4de832017-09-19 14:53:16 +0530306 self._set_in_company_currency(self.doc, ["total_taxes_and_charges", "rounding_adjustment"])
Anand Doshiec5ec602015-03-05 19:31:23 +0530307
Nabin Haitbd00e812015-02-17 12:50:51 +0530308 if self.doc.doctype in ["Quotation", "Sales Order", "Delivery Note", "Sales Invoice"]:
Nabin Haite7679702015-02-20 14:40:35 +0530309 self.doc.base_grand_total = flt(self.doc.grand_total * self.doc.conversion_rate) \
310 if self.doc.total_taxes_and_charges else self.doc.base_net_total
Nabin Hait3237c752015-02-17 11:11:11 +0530311 else:
Anand Doshiec5ec602015-03-05 19:31:23 +0530312 self.doc.taxes_and_charges_added = self.doc.taxes_and_charges_deducted = 0.0
Nabin Hait3237c752015-02-17 11:11:11 +0530313 for tax in self.doc.get("taxes"):
314 if tax.category in ["Valuation and Total", "Total"]:
315 if tax.add_deduct_tax == "Add":
Nabin Haitdb53a782015-07-31 16:53:13 +0530316 self.doc.taxes_and_charges_added += flt(tax.tax_amount_after_discount_amount)
Nabin Hait3237c752015-02-17 11:11:11 +0530317 else:
Nabin Haitdb53a782015-07-31 16:53:13 +0530318 self.doc.taxes_and_charges_deducted += flt(tax.tax_amount_after_discount_amount)
Nabin Hait3237c752015-02-17 11:11:11 +0530319
Nabin Haite7679702015-02-20 14:40:35 +0530320 self.doc.round_floats_in(self.doc, ["taxes_and_charges_added", "taxes_and_charges_deducted"])
Nabin Hait3237c752015-02-17 11:11:11 +0530321
Nabin Haite7679702015-02-20 14:40:35 +0530322 self.doc.base_grand_total = flt(self.doc.grand_total * self.doc.conversion_rate) \
323 if (self.doc.taxes_and_charges_added or self.doc.taxes_and_charges_deducted) \
324 else self.doc.base_net_total
Nabin Hait3237c752015-02-17 11:11:11 +0530325
Nabin Hait2e4de832017-09-19 14:53:16 +0530326 self._set_in_company_currency(self.doc,
327 ["taxes_and_charges_added", "taxes_and_charges_deducted"])
Nabin Hait3237c752015-02-17 11:11:11 +0530328
Nabin Haite7679702015-02-20 14:40:35 +0530329 self.doc.round_floats_in(self.doc, ["grand_total", "base_grand_total"])
Nabin Hait3237c752015-02-17 11:11:11 +0530330
Nabin Hait2e4de832017-09-19 14:53:16 +0530331 self.set_rounded_total()
332
rohitwaghchaurea8fb2db2018-05-26 09:23:02 +0530333 def calculate_total_net_weight(self):
334 if self.doc.meta.get_field('total_net_weight'):
335 self.doc.total_net_weight = 0.0
336 for d in self.doc.items:
337 if d.total_weight:
338 self.doc.total_net_weight += d.total_weight
339
Nabin Hait2e4de832017-09-19 14:53:16 +0530340 def set_rounded_total(self):
Nabin Hait3237c752015-02-17 11:11:11 +0530341 if self.doc.meta.get_field("rounded_total"):
Nabin Hait877e1bb2017-11-17 12:27:43 +0530342 if self.doc.is_rounded_total_disabled():
343 self.doc.rounded_total = self.doc.base_rounded_total = 0
344 return
345
Anand Doshi15f7b1e2016-04-04 15:03:28 +0530346 self.doc.rounded_total = round_based_on_smallest_currency_fraction(self.doc.grand_total,
Nabin Haitfb0b24a2016-01-20 14:46:26 +0530347 self.doc.currency, self.doc.precision("rounded_total"))
Nabin Hait2e4de832017-09-19 14:53:16 +0530348
Nabin Hait877e1bb2017-11-17 12:27:43 +0530349 #if print_in_rate is set, we would have already calculated rounding adjustment
350 self.doc.rounding_adjustment += flt(self.doc.rounded_total - self.doc.grand_total,
351 self.doc.precision("rounding_adjustment"))
352
Nabin Hait02ac9012017-11-22 16:12:20 +0530353 self._set_in_company_currency(self.doc, ["rounding_adjustment", "rounded_total"])
Nabin Hait877e1bb2017-11-17 12:27:43 +0530354
Nabin Hait3237c752015-02-17 11:11:11 +0530355 def _cleanup(self):
356 for tax in self.doc.get("taxes"):
357 tax.item_wise_tax_detail = json.dumps(tax.item_wise_tax_detail, separators=(',', ':'))
Anand Doshi15f7b1e2016-04-04 15:03:28 +0530358
Nabin Hait3769d872015-12-18 13:12:02 +0530359 def set_discount_amount(self):
Nabin Haite0405102016-10-13 12:14:32 +0530360 if self.doc.additional_discount_percentage:
Anand Doshi15f7b1e2016-04-04 15:03:28 +0530361 self.doc.discount_amount = flt(flt(self.doc.get(scrub(self.doc.apply_discount_on)))
Nabin Hait3769d872015-12-18 13:12:02 +0530362 * self.doc.additional_discount_percentage / 100, self.doc.precision("discount_amount"))
Nabin Hait3237c752015-02-17 11:11:11 +0530363
364 def apply_discount_amount(self):
365 if self.doc.discount_amount:
Nabin Hait37b047d2015-02-23 16:01:33 +0530366 if not self.doc.apply_discount_on:
367 frappe.throw(_("Please select Apply Discount On"))
368
Nabin Hait3237c752015-02-17 11:11:11 +0530369 self.doc.base_discount_amount = flt(self.doc.discount_amount * self.doc.conversion_rate,
370 self.doc.precision("base_discount_amount"))
371
Nabin Haite7679702015-02-20 14:40:35 +0530372 total_for_discount_amount = self.get_total_for_discount_amount()
Nabin Hait25bd84d2015-03-04 15:06:56 +0530373 taxes = self.doc.get("taxes")
374 net_total = 0
Nabin Hait3237c752015-02-17 11:11:11 +0530375
Nabin Haite7679702015-02-20 14:40:35 +0530376 if total_for_discount_amount:
Nabin Hait3237c752015-02-17 11:11:11 +0530377 # calculate item amount after Discount Amount
Nabin Hait25bd84d2015-03-04 15:06:56 +0530378 for i, item in enumerate(self.doc.get("items")):
379 distributed_amount = flt(self.doc.discount_amount) * \
380 item.net_amount / total_for_discount_amount
Anand Doshiec5ec602015-03-05 19:31:23 +0530381
Nabin Haite7679702015-02-20 14:40:35 +0530382 item.net_amount = flt(item.net_amount - distributed_amount, item.precision("net_amount"))
Nabin Hait25bd84d2015-03-04 15:06:56 +0530383 net_total += item.net_amount
Anand Doshiec5ec602015-03-05 19:31:23 +0530384
Nabin Hait25bd84d2015-03-04 15:06:56 +0530385 # discount amount rounding loss adjustment if no taxes
386 if (not taxes or self.doc.apply_discount_on == "Net Total") \
387 and i == len(self.doc.get("items")) - 1:
Rushabh Mehtac6bd7ad2016-12-21 17:30:29 +0530388 discount_amount_loss = flt(self.doc.net_total - net_total - self.doc.discount_amount,
Nabin Hait25bd84d2015-03-04 15:06:56 +0530389 self.doc.precision("net_total"))
Rushabh Mehtac6bd7ad2016-12-21 17:30:29 +0530390
Anand Doshiec5ec602015-03-05 19:31:23 +0530391 item.net_amount = flt(item.net_amount + discount_amount_loss,
Nabin Hait25bd84d2015-03-04 15:06:56 +0530392 item.precision("net_amount"))
Anand Doshiec5ec602015-03-05 19:31:23 +0530393
Nabin Hait51e980d2015-10-10 18:10:05 +0530394 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 +0530395
Nabin Haite7679702015-02-20 14:40:35 +0530396 self._set_in_company_currency(item, ["net_rate", "net_amount"])
Nabin Hait3237c752015-02-17 11:11:11 +0530397
398 self.discount_amount_applied = True
399 self._calculate()
400 else:
401 self.doc.base_discount_amount = 0
402
Nabin Haite7679702015-02-20 14:40:35 +0530403 def get_total_for_discount_amount(self):
Nabin Haitde9c8a92015-02-23 01:06:00 +0530404 if self.doc.apply_discount_on == "Net Total":
405 return self.doc.net_total
Nabin Haite7679702015-02-20 14:40:35 +0530406 else:
407 actual_taxes_dict = {}
Nabin Hait3237c752015-02-17 11:11:11 +0530408
Nabin Haite7679702015-02-20 14:40:35 +0530409 for tax in self.doc.get("taxes"):
410 if tax.charge_type == "Actual":
Nabin Haitaf9bdfe2017-12-12 18:50:05 +0530411 tax_amount = self.get_tax_amount_if_for_valuation_or_deduction(tax.tax_amount, tax)
412 actual_taxes_dict.setdefault(tax.idx, tax_amount)
Nabin Haite7679702015-02-20 14:40:35 +0530413 elif tax.row_id in actual_taxes_dict:
414 actual_tax_amount = flt(actual_taxes_dict.get(tax.row_id, 0)) * flt(tax.rate) / 100
415 actual_taxes_dict.setdefault(tax.idx, actual_tax_amount)
Nabin Hait3237c752015-02-17 11:11:11 +0530416
Nabin Hait877e1bb2017-11-17 12:27:43 +0530417 return flt(self.doc.grand_total - sum(actual_taxes_dict.values()),
418 self.doc.precision("grand_total"))
Nabin Hait3237c752015-02-17 11:11:11 +0530419
420
Nabin Hait7b19b9e2015-02-24 09:42:24 +0530421 def calculate_total_advance(self):
422 if self.doc.docstatus < 2:
Nabin Haite7679702015-02-20 14:40:35 +0530423 total_allocated_amount = sum([flt(adv.allocated_amount, adv.precision("allocated_amount"))
Nabin Hait3237c752015-02-17 11:11:11 +0530424 for adv in self.doc.get("advances")])
425
Nabin Haite7679702015-02-20 14:40:35 +0530426 self.doc.total_advance = flt(total_allocated_amount, self.doc.precision("total_advance"))
Anand Doshi15f7b1e2016-04-04 15:03:28 +0530427
Faris Ansari6041f5c2018-02-08 13:33:52 +0530428 grand_total = self.doc.rounded_total or self.doc.grand_total
429
Nabin Hait289ffb72016-02-08 11:06:55 +0530430 if self.doc.party_account_currency == self.doc.currency:
Faris Ansari6041f5c2018-02-08 13:33:52 +0530431 invoice_total = flt(grand_total - flt(self.doc.write_off_amount),
Nabin Hait289ffb72016-02-08 11:06:55 +0530432 self.doc.precision("grand_total"))
Nabin Hait8d8cba72017-04-03 17:26:22 +0530433 else:
Vishal Dhayaguded42242d2017-11-29 16:09:59 +0530434 base_write_off_amount = flt(flt(self.doc.write_off_amount) * self.doc.conversion_rate,
Nabin Hait8d8cba72017-04-03 17:26:22 +0530435 self.doc.precision("base_write_off_amount"))
Faris Ansari6041f5c2018-02-08 13:33:52 +0530436 invoice_total = flt(grand_total * self.doc.conversion_rate,
Nabin Hait8d8cba72017-04-03 17:26:22 +0530437 self.doc.precision("grand_total")) - base_write_off_amount
Vishal Dhayaguded42242d2017-11-29 16:09:59 +0530438
Nabin Haitadc09232016-02-09 10:31:11 +0530439 if invoice_total > 0 and self.doc.total_advance > invoice_total:
Nabin Hait289ffb72016-02-08 11:06:55 +0530440 frappe.throw(_("Advance amount cannot be greater than {0} {1}")
441 .format(self.doc.party_account_currency, invoice_total))
Nabin Hait3237c752015-02-17 11:11:11 +0530442
Rushabh Mehta8bb6e532015-02-18 20:22:59 +0530443 if self.doc.docstatus == 0:
Nabin Hait3237c752015-02-17 11:11:11 +0530444 self.calculate_outstanding_amount()
445
446 def calculate_outstanding_amount(self):
447 # NOTE:
448 # write_off_amount is only for POS Invoice
449 # total_advance is only for non POS Invoice
Rohit Waghchaureefb5bf22016-08-25 02:09:53 +0530450 if self.doc.doctype == "Sales Invoice":
451 self.calculate_paid_amount()
452
rohitwaghchaure70489252018-06-11 12:02:14 +0530453 if self.doc.is_return and self.doc.return_against: return
Anand Doshi15f7b1e2016-04-04 15:03:28 +0530454
Nabin Hait4ffd7f32015-08-27 12:28:36 +0530455 self.doc.round_floats_in(self.doc, ["grand_total", "total_advance", "write_off_amount"])
Anand Doshi15f7b1e2016-04-04 15:03:28 +0530456 self._set_in_company_currency(self.doc, ['write_off_amount'])
457
Nabin Hait877e1bb2017-11-17 12:27:43 +0530458 if self.doc.doctype in ["Sales Invoice", "Purchase Invoice"]:
459 grand_total = self.doc.rounded_total or self.doc.grand_total
460 if self.doc.party_account_currency == self.doc.currency:
461 total_amount_to_pay = flt(grand_total - self.doc.total_advance
462 - flt(self.doc.write_off_amount), self.doc.precision("grand_total"))
463 else:
464 total_amount_to_pay = flt(flt(grand_total *
465 self.doc.conversion_rate, self.doc.precision("grand_total")) - self.doc.total_advance
466 - flt(self.doc.base_write_off_amount), self.doc.precision("grand_total"))
Anand Doshi15f7b1e2016-04-04 15:03:28 +0530467
Nabin Hait4ffd7f32015-08-27 12:28:36 +0530468 self.doc.round_floats_in(self.doc, ["paid_amount"])
Nabin Hait877e1bb2017-11-17 12:27:43 +0530469 change_amount = 0
470
471 if self.doc.doctype == "Sales Invoice":
472 self.calculate_write_off_amount()
473 self.calculate_change_amount()
474 change_amount = self.doc.change_amount \
475 if self.doc.party_account_currency == self.doc.currency else self.doc.base_change_amount
476
Nabin Haitac3b2aa2017-05-30 15:35:01 +0530477 paid_amount = self.doc.paid_amount \
478 if self.doc.party_account_currency == self.doc.currency else self.doc.base_paid_amount
Rohit Waghchaure6087fe12016-04-09 14:31:09 +0530479
Rohit Waghchaure609e2b42016-08-31 02:04:37 +0530480
Nabin Hait877e1bb2017-11-17 12:27:43 +0530481 self.doc.outstanding_amount = flt(total_amount_to_pay - flt(paid_amount) + flt(change_amount),
482 self.doc.precision("outstanding_amount"))
Rushabh Mehtac6bd7ad2016-12-21 17:30:29 +0530483
Rohit Waghchaure6087fe12016-04-09 14:31:09 +0530484 def calculate_paid_amount(self):
485 paid_amount = base_paid_amount = 0.0
Rohit Waghchauref58cad62017-01-17 12:11:57 +0530486
487 if self.doc.is_pos:
488 for payment in self.doc.get('payments'):
Ayush Shuklae9cf1ab2017-05-25 14:14:55 +0530489 payment.amount = flt(payment.amount)
490 payment.base_amount = payment.amount * flt(self.doc.conversion_rate)
Rohit Waghchauref58cad62017-01-17 12:11:57 +0530491 paid_amount += payment.amount
492 base_paid_amount += payment.base_amount
rohitwaghchaure73456ac2017-05-16 11:29:57 +0530493 elif not self.doc.is_return:
494 self.doc.set('payments', [])
Rohit Waghchaure6087fe12016-04-09 14:31:09 +0530495
496 self.doc.paid_amount = flt(paid_amount, self.doc.precision("paid_amount"))
497 self.doc.base_paid_amount = flt(base_paid_amount, self.doc.precision("base_paid_amount"))
498
Nabin Hait3bb1a422016-08-02 16:41:10 +0530499 def calculate_change_amount(self):
500 self.doc.change_amount = 0.0
Rohit Waghchaure609e2b42016-08-31 02:04:37 +0530501 self.doc.base_change_amount = 0.0
Nabin Hait877e1bb2017-11-17 12:27:43 +0530502
503 if self.doc.doctype == "Sales Invoice" \
504 and self.doc.paid_amount > self.doc.grand_total and not self.doc.is_return \
Nabin Haitac3b2aa2017-05-30 15:35:01 +0530505 and any([d.type == "Cash" for d in self.doc.payments]):
Rohit Waghchauree8d22bb2018-02-05 18:13:29 +0530506 grand_total = self.doc.rounded_total or self.doc.grand_total
507 base_grand_total = self.doc.base_rounded_total or self.doc.base_grand_total
Nabin Haitac3b2aa2017-05-30 15:35:01 +0530508
Rohit Waghchauree8d22bb2018-02-05 18:13:29 +0530509 self.doc.change_amount = flt(self.doc.paid_amount - grand_total +
Nabin Hait3bb1a422016-08-02 16:41:10 +0530510 self.doc.write_off_amount, self.doc.precision("change_amount"))
Rohit Waghchaure6087fe12016-04-09 14:31:09 +0530511
Rohit Waghchauree8d22bb2018-02-05 18:13:29 +0530512 self.doc.base_change_amount = flt(self.doc.base_paid_amount - base_grand_total +
Rohit Waghchaure609e2b42016-08-31 02:04:37 +0530513 self.doc.base_write_off_amount, self.doc.precision("base_change_amount"))
mbauskar36b51892016-01-18 16:31:10 +0530514
Rohit Waghchaure7127a8f2016-08-04 14:56:15 +0530515 def calculate_write_off_amount(self):
Rohit Waghchaurebaef2622016-08-05 15:41:36 +0530516 if flt(self.doc.change_amount) > 0:
Nabin Hait877e1bb2017-11-17 12:27:43 +0530517 self.doc.write_off_amount = flt(self.doc.grand_total - self.doc.paid_amount
518 + self.doc.change_amount, self.doc.precision("write_off_amount"))
Rohit Waghchaurebaef2622016-08-05 15:41:36 +0530519 self.doc.base_write_off_amount = flt(self.doc.write_off_amount * self.doc.conversion_rate,
520 self.doc.precision("base_write_off_amount"))
Rohit Waghchaure7127a8f2016-08-04 14:56:15 +0530521
mbauskar36b51892016-01-18 16:31:10 +0530522 def calculate_margin(self, item):
Shreya Shahf718b0c2018-02-20 11:26:46 +0530523
Makarand Bauskar0e4c5c92017-05-11 11:40:02 +0530524 rate_with_margin = 0.0
Shreya Shahbe690ef2017-11-14 17:22:41 +0530525 base_rate_with_margin = 0.0
mbauskar36b51892016-01-18 16:31:10 +0530526 if item.price_list_rate:
Rushabh Mehtac6bd7ad2016-12-21 17:30:29 +0530527 if item.pricing_rule and not self.doc.ignore_pricing_rule:
mbauskar36b51892016-01-18 16:31:10 +0530528 pricing_rule = frappe.get_doc('Pricing Rule', item.pricing_rule)
Shreya Shahf718b0c2018-02-20 11:26:46 +0530529
Shreya Shah1906cad2018-05-16 11:20:30 +0530530 if (pricing_rule.margin_type == 'Amount' and pricing_rule.currency == self.doc.currency)\
531 or (pricing_rule.margin_type == 'Percentage'):
Shreya Shahf718b0c2018-02-20 11:26:46 +0530532 item.margin_type = pricing_rule.margin_type
533 item.margin_rate_or_amount = pricing_rule.margin_rate_or_amount
534 else:
535 item.margin_type = None
536 item.margin_rate_or_amount = 0.0
mbauskar36b51892016-01-18 16:31:10 +0530537
mbauskara52472c2016-03-05 15:10:25 +0530538 if item.margin_type and item.margin_rate_or_amount:
539 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 +0530540 rate_with_margin = flt(item.price_list_rate) + flt(margin_value)
Shreya Shahbe690ef2017-11-14 17:22:41 +0530541 base_rate_with_margin = flt(rate_with_margin) * flt(self.doc.conversion_rate)
mbauskar36b51892016-01-18 16:31:10 +0530542
Shreya Shahbe690ef2017-11-14 17:22:41 +0530543 return rate_with_margin, base_rate_with_margin
Nabin Hait852cb642017-07-05 12:58:19 +0530544
545 def set_item_wise_tax_breakup(self):
Nabin Hait9c421612017-07-20 13:32:01 +0530546 self.doc.other_charges_calculation = get_itemised_tax_breakup_html(self.doc)
Vishal Dhayaguded42242d2017-11-29 16:09:59 +0530547
Nabin Hait9c421612017-07-20 13:32:01 +0530548def get_itemised_tax_breakup_html(doc):
549 if not doc.taxes:
550 return
551 frappe.flags.company = doc.company
Vishal Dhayaguded42242d2017-11-29 16:09:59 +0530552
Nabin Hait9c421612017-07-20 13:32:01 +0530553 # get headers
Nabin Haitcaab5822017-08-24 16:22:28 +0530554 tax_accounts = []
555 for tax in doc.taxes:
556 if getattr(tax, "category", None) and tax.category=="Valuation":
557 continue
rohitwaghchaure4e17fae2017-12-12 14:40:52 +0530558 if tax.description not in tax_accounts:
Nabin Haitcaab5822017-08-24 16:22:28 +0530559 tax_accounts.append(tax.description)
560
Nabin Hait9c421612017-07-20 13:32:01 +0530561 headers = get_itemised_tax_breakup_header(doc.doctype + " Item", tax_accounts)
Vishal Dhayaguded42242d2017-11-29 16:09:59 +0530562
Nabin Hait9c421612017-07-20 13:32:01 +0530563 # get tax breakup data
564 itemised_tax, itemised_taxable_amount = get_itemised_tax_breakup_data(doc)
Nabin Haitcaab5822017-08-24 16:22:28 +0530565
566 get_rounded_tax_amount(itemised_tax, doc.precision("tax_amount", "taxes"))
567
rohitwaghchaured4526682017-12-28 14:20:13 +0530568 update_itemised_tax_data(doc)
Nabin Hait9c421612017-07-20 13:32:01 +0530569 frappe.flags.company = None
Vishal Dhayaguded42242d2017-11-29 16:09:59 +0530570
Nabin Hait9c421612017-07-20 13:32:01 +0530571 return frappe.render_template(
572 "templates/includes/itemised_tax_breakup.html", dict(
573 headers=headers,
574 itemised_tax=itemised_tax,
575 itemised_taxable_amount=itemised_taxable_amount,
576 tax_accounts=tax_accounts,
Faris Ansari69b05352018-05-14 14:19:31 +0530577 conversion_rate=doc.conversion_rate,
578 currency=doc.currency
Nabin Haitb962fc12017-07-17 18:02:31 +0530579 )
Nabin Hait9c421612017-07-20 13:32:01 +0530580 )
Nabin Hait852cb642017-07-05 12:58:19 +0530581
rohitwaghchaured4526682017-12-28 14:20:13 +0530582
583@erpnext.allow_regional
584def update_itemised_tax_data(doc):
585 #Don't delete this method, used for localization
586 pass
587
Nabin Haitb962fc12017-07-17 18:02:31 +0530588@erpnext.allow_regional
589def get_itemised_tax_breakup_header(item_doctype, tax_accounts):
590 return [_("Item"), _("Taxable Amount")] + tax_accounts
591
592@erpnext.allow_regional
593def get_itemised_tax_breakup_data(doc):
594 itemised_tax = get_itemised_tax(doc.taxes)
595
596 itemised_taxable_amount = get_itemised_taxable_amount(doc.items)
597
598 return itemised_tax, itemised_taxable_amount
599
600def get_itemised_tax(taxes):
601 itemised_tax = {}
602 for tax in taxes:
Nabin Haitcaab5822017-08-24 16:22:28 +0530603 if getattr(tax, "category", None) and tax.category=="Valuation":
604 continue
605
Nabin Haitb962fc12017-07-17 18:02:31 +0530606 item_tax_map = json.loads(tax.item_wise_tax_detail) if tax.item_wise_tax_detail else {}
Nabin Hait2e4de832017-09-19 14:53:16 +0530607 if item_tax_map:
608 for item_code, tax_data in item_tax_map.items():
609 itemised_tax.setdefault(item_code, frappe._dict())
Vishal Dhayaguded42242d2017-11-29 16:09:59 +0530610
Prateeksha Singhea7533f2018-06-11 13:31:33 +0530611 tax_rate = 0.0
612 tax_amount = 0.0
613
Nabin Hait2e4de832017-09-19 14:53:16 +0530614 if isinstance(tax_data, list):
Prateeksha Singhea7533f2018-06-11 13:31:33 +0530615 tax_rate = flt(tax_data[0])
616 tax_amount = flt(tax_data[1])
Nabin Hait2e4de832017-09-19 14:53:16 +0530617 else:
Prateeksha Singhea7533f2018-06-11 13:31:33 +0530618 tax_rate = flt(tax_data)
619
620 itemised_tax[item_code][tax.description] = frappe._dict(dict(
621 tax_rate = tax_rate,
622 tax_amount = tax_amount
623 ))
Rohit Waghchaure296fbfe2017-07-10 13:03:29 +0530624
Nabin Haitb962fc12017-07-17 18:02:31 +0530625 return itemised_tax
626
627def get_itemised_taxable_amount(items):
628 itemised_taxable_amount = frappe._dict()
629 for item in items:
Rohit Waghchaure296fbfe2017-07-10 13:03:29 +0530630 item_code = item.item_code or item.item_name
Nabin Haitb962fc12017-07-17 18:02:31 +0530631 itemised_taxable_amount.setdefault(item_code, 0)
632 itemised_taxable_amount[item_code] += item.net_amount
633
Nabin Haitcaab5822017-08-24 16:22:28 +0530634 return itemised_taxable_amount
635
636def get_rounded_tax_amount(itemised_tax, precision):
637 # Rounding based on tax_amount precision
638 for taxes in itemised_tax.values():
639 for tax_account in taxes:
640 taxes[tax_account]["tax_amount"] = flt(taxes[tax_account]["tax_amount"], precision)