feat(regional | India): auto-generate e-Way Bill JSON from Sales Invoice

erpnext/accounts/doctype/sales_invoice/regional/india.js

@@ -0,0 +1,38 @@
+frappe.ui.form.on("Sales Invoice", {
+	setup: function(frm) {
+		frm.set_query('transporter', function() {
+			return {
+				filters: {
+					'is_transporter': 1
+				}
+			}
+		});
+
+		frm.set_query('driver', function(doc) {
+			return {
+				filters: {
+					'transporter': doc.transporter
+				}
+			}
+		});
+	},
+
+	refresh: function(frm) {
+		if(frm.doc.docstatus == 1 && !frm.is_dirty()
+			&& !frm.doc.is_return && !frm.doc.ewaybill) {
+
+			frm.add_custom_button('Generate e-Way Bill JSON', () => {
+				var w = window.open(
+					frappe.urllib.get_full_url(
+						"/api/method/erpnext.regional.india.utils.generate_ewb_json?"
+						+ "dt=" + encodeURIComponent(frm.doc.doctype)
+						+ "&dn=" + encodeURIComponent(frm.doc.name)
+					)
+				);
+				if (!w) {
+					frappe.msgprint(__("Please enable pop-ups")); return;
+				}
+			});
+		}
+	}
+});

erpnext/accounts/doctype/sales_invoice/regional/india_list.js

@@ -0,0 +1,33 @@
+var globalOnload = frappe.listview_settings['Sales Invoice'].onload;
+frappe.listview_settings['Sales Invoice'].onload = function (doclist) {
+
+	// Provision in case onload event is added to sales_invoice.js in future
+	if (globalOnload) {
+		globalOnload(doclist);
+	}
+
+	const action = () => {
+		const selected_docs = doclist.get_checked_items();
+		const docnames = doclist.get_checked_items(true);
+
+		for (let doc of selected_docs) {
+			if (doc.docstatus !== 1) {
+				frappe.throw(__("e-Way Bill JSON can only be generated from a submitted document"));
+			}
+		}
+
+		var w = window.open(
+			frappe.urllib.get_full_url(
+				"/api/method/erpnext.regional.india.utils.generate_ewb_json?"
+				+ "dt=" + encodeURIComponent(doclist.doctype)
+				+ "&dn=" + encodeURIComponent(docnames)
+			)
+		);
+		if (!w) {
+			frappe.msgprint(__("Please enable pop-ups")); return;
+		}
+
+	}
+
+	doclist.page.add_actions_menu_item(__('Generate e-Way Bill JSON'), action, false);
+}

erpnext/controllers/taxes_and_totals.py

@@ -630,7 +630,8 @@ def get_itemised_tax(taxes):
 
 				itemised_tax[item_code][tax.description] = frappe._dict(dict(
 					tax_rate = tax_rate,
-					tax_amount = tax_amount
+					tax_amount = tax_amount,
+					tax_account = tax.account_head
 				))
 
 	return itemised_tax

erpnext/regional/india/setup.py

@@ -189,9 +189,10 @@ def make_custom_fields(update=True):
 			'fieldname': 'gst_transporter_id',
 			'label': 'GST Transporter ID',
 			'fieldtype': 'Data',
-			'insert_after': 'transporter_name',
+			'insert_after': 'transporter',
 			'fetch_from': 'transporter.gst_transporter_id',
-			'print_hide': 1
+			'print_hide': 1,
+			'translatable': 0
 		},
 		{
 			'fieldname': 'mode_of_transport',
@@ -199,18 +200,142 @@ def make_custom_fields(update=True):
 			'fieldtype': 'Select',
 			'options': '\nRoad\nAir\nRail\nShip',
 			'default': 'Road',
+			'insert_after': 'transporter_name',
+			'print_hide': 1,
+			'translatable': 0
+		},
+		{
+			'fieldname': 'gst_vehicle_type',
+			'label': 'GST Vehicle Type',
+			'fieldtype': 'Select',
+			'options': 'Regular\nOver Dimensional Cargo (ODC)',
+			'depends_on': 'eval:(doc.mode_of_transport === "Road")',
+			'default': 'Regular',
 			'insert_after': 'lr_date',
+			'print_hide': 1,
+			'translatable': 0
+		}
+	]
+
+	si_ewaybill_fields = [
+		{
+			'fieldname': 'transporter_info',
+ 			'label': 'Transporter Info',
+ 			'fieldtype': 'Section Break',
+ 			'insert_after': 'terms',
+ 			'collapsible': 1,
+ 			'collapsible_depends_on': 'transporter',
+ 			'print_hide': 1
+		},
+		{
+			'fieldname': 'transporter',
+			'label': 'Transporter',
+			'fieldtype': 'Link',
+			'insert_after': 'transporter_info',
+			'options': 'Supplier',
+			'print_hide': 1
+		},
+		{
+			'fieldname': 'gst_transporter_id',
+			'label': 'GST Transporter ID',
+			'fieldtype': 'Data',
+			'insert_after': 'transporter',
+			'fetch_from': 'transporter.gst_transporter_id',
+			'print_hide': 1,
+			'translatable': 0
+		},
+		{
+			'fieldname': 'driver',
+			'label': 'Driver',
+			'fieldtype': 'Link',
+			'insert_after': 'gst_transporter_id',
+			'options': 'Driver',
+			'print_hide': 1
+		},
+		{
+			'fieldname': 'lr_no',
+			'label': 'Transport Receipt No',
+			'fieldtype': 'Data',
+			'insert_after': 'driver',
+			'print_hide': 1,
+			'translatable': 0
+		},
+		{
+			'fieldname': 'vehicle_no',
+			'label': 'Vehicle No',
+			'fieldtype': 'Data',
+			'insert_after': 'lr_no',
+			'print_hide': 1,
+			'translatable': 0
+		},
+		{
+			'fieldname': 'distance',
+			'label': 'Distance (in km)',
+			'fieldtype': 'Float',
+			'insert_after': 'vehicle_no',
+			'print_hide': 1
+		},
+		{
+			'fieldname': 'transporter_col_break',
+			'fieldtype': 'Column Break',
+			'insert_after': 'distance'
+		},
+		{
+			'fieldname': 'transporter_name',
+			'label': 'Transporter Name',
+			'fieldtype': 'Data',
+			'insert_after': 'transporter_col_break',
+			'fetch_from': 'transporter.name',
+			'read_only': 1,
+			'print_hide': 1,
+			'translatable': 0
+		},
+		{
+			'fieldname': 'mode_of_transport',
+			'label': 'Mode of Transport',
+			'fieldtype': 'Select',
+			'options': '\nRoad\nAir\nRail\nShip',
+			'default': 'Road',
+			'insert_after': 'transporter_name',
+			'print_hide': 1,
+			'translatable': 0
+		},
+		{
+			'fieldname': 'driver_name',
+			'label': 'Driver Name',
+			'fieldtype': 'Data',
+			'insert_after': 'mode_of_transport',
+			'fetch_from': 'driver.full_name',
+			'print_hide': 1,
+			'translatable': 0
+		},
+		{
+			'fieldname': 'lr_date',
+			'label': 'Transport Receipt Date',
+			'fieldtype': 'Date',
+			'insert_after': 'driver_name',
+			'default': 'Today',
 			'print_hide': 1
 		},
 		{
 			'fieldname': 'gst_vehicle_type',
 			'label': 'GST Vehicle Type',
 			'fieldtype': 'Select',
-			'options': '\nRegular\nOver Dimensional Cargo (ODC)',
-			'default': 'Regular',
+			'options': 'Regular\nOver Dimensional Cargo (ODC)',
 			'depends_on': 'eval:(doc.mode_of_transport === "Road")',
-			'insert_after': 'mode_of_transport',
-			'print_hide': 1
+			'default': 'Regular',
+			'insert_after': 'lr_date',
+			'print_hide': 1,
+			'translatable': 0
+		},
+		{
+			'fieldname': 'ewaybill',
+			'label': 'e-Way Bill No.',
+			'fieldtype': 'Data',
+			'depends_on': 'eval:(doc.docstatus === 1)',
+			'allow_on_submit': 1,
+			'insert_after': 'project',
+			'translatable': 0
 		}
 	]
 
@@ -226,7 +351,8 @@ def make_custom_fields(update=True):
 		'Purchase Invoice': invoice_gst_fields + purchase_invoice_gst_fields + purchase_invoice_itc_fields,
 		'Purchase Order': purchase_invoice_gst_fields,
 		'Purchase Receipt': purchase_invoice_gst_fields,
-		'Sales Invoice': invoice_gst_fields + sales_invoice_gst_fields + sales_invoice_shipping_fields,
+		'Sales Invoice': (invoice_gst_fields + sales_invoice_gst_fields
+			+ sales_invoice_shipping_fields + si_ewaybill_fields),
 		'Delivery Note': sales_invoice_gst_fields + ewaybill_fields + sales_invoice_shipping_fields,
 		'Sales Order': sales_invoice_gst_fields,
 		'Sales Taxes and Charges Template': inter_state_gst_field,

erpnext/regional/india/utils.py

@@ -1,5 +1,5 @@
 from __future__ import unicode_literals
-import frappe, re
+import frappe, re, json
 from frappe import _
 from frappe.utils import cstr, flt, date_diff, getdate
 from erpnext.regional.india import states, state_numbers
@@ -14,6 +14,8 @@ def validate_gstin_for_india(doc, method):
 	if not hasattr(doc, 'gstin') or not doc.gstin:
 		return
 
+	set_gst_state_and_state_number(doc)
+
 	doc.gstin = doc.gstin.upper().strip() if doc.gstin else ""
 	if not doc.gstin or doc.gstin == 'NA':
 		return
@@ -27,6 +29,11 @@ def validate_gstin_for_india(doc, method):
 
 	validate_gstin_check_digit(doc.gstin)
 
+	if doc.gst_state_number != doc.gstin[:2]:
+		frappe.throw(_("Invalid GSTIN! First 2 digits of GSTIN should match with State number {0}.")
+			.format(doc.gst_state_number))
+
+def set_gst_state_and_state_number(doc):
 	if not doc.gst_state:
 		if not doc.state:
 			return
@@ -38,11 +45,9 @@ def validate_gstin_for_india(doc, method):
 			return
 
 	doc.gst_state_number = state_numbers[doc.gst_state]
-	if doc.gst_state_number != doc.gstin[:2]:
-		frappe.throw(_("Invalid GSTIN! First 2 digits of GSTIN should match with State number {0}.")
-			.format(doc.gst_state_number))
 
-def validate_gstin_check_digit(gstin):
+
+def validate_gstin_check_digit(gstin, label='GSTIN'):
 	''' Function to validate the check digit of the GSTIN.'''
 	factor = 1
 	total = 0
@@ -55,8 +60,8 @@ def validate_gstin_check_digit(gstin):
 		total += digit
 		factor = 2 if factor == 1 else 1
 	if gstin[-1] != code_point_chars[((mod - (total % mod)) % mod)]:
-		frappe.throw(_("Invalid GSTIN! The check digit validation has failed. " +
-			"Please ensure you've typed the GSTIN correctly."))
+		frappe.throw(_("Invalid {0}! The check digit validation has failed. " +
+			"Please ensure you've typed the {0} correctly.".format(label)))
 
 def get_itemised_tax_breakup_header(item_doctype, tax_accounts):
 	if frappe.get_meta(item_doctype).has_field('gst_hsn_code'):
@@ -64,7 +69,7 @@ def get_itemised_tax_breakup_header(item_doctype, tax_accounts):
 	else:
 		return [_("Item"), _("Taxable Amount")] + tax_accounts
 
-def get_itemised_tax_breakup_data(doc):
+def get_itemised_tax_breakup_data(doc, account_wise=False):
 	itemised_tax = get_itemised_tax(doc.taxes)
 
 	itemised_taxable_amount = get_itemised_taxable_amount(doc.items)
@@ -80,14 +85,17 @@ def get_itemised_tax_breakup_data(doc):
 	for item, taxes in itemised_tax.items():
 		hsn_code = item_hsn_map.get(item)
 		hsn_tax.setdefault(hsn_code, frappe._dict())
-		for tax_account, tax_detail in taxes.items():
-			hsn_tax[hsn_code].setdefault(tax_account, {"tax_rate": 0, "tax_amount": 0})
-			hsn_tax[hsn_code][tax_account]["tax_rate"] = tax_detail.get("tax_rate")
-			hsn_tax[hsn_code][tax_account]["tax_amount"] += tax_detail.get("tax_amount")
+		for tax_desc, tax_detail in taxes.items():
+			key = tax_desc
+			if account_wise:
+				key = tax_detail.get('tax_account')
+			hsn_tax[hsn_code].setdefault(key, {"tax_rate": 0, "tax_amount": 0})
+			hsn_tax[hsn_code][key]["tax_rate"] = tax_detail.get("tax_rate")
+			hsn_tax[hsn_code][key]["tax_amount"] += tax_detail.get("tax_amount")
 
 	# set taxable amount
 	hsn_taxable_amount = frappe._dict()
-	for item, taxable_amount in itemised_taxable_amount.items():
+	for item in itemised_taxable_amount:
 		hsn_code = item_hsn_map.get(item)
 		hsn_taxable_amount.setdefault(hsn_code, 0)
 		hsn_taxable_amount[hsn_code] += itemised_taxable_amount.get(item)
@@ -234,3 +242,238 @@ def calculate_hra_exemption_for_period(doc):
 		exemptions["monthly_house_rent"] = monthly_rent
 		exemptions["total_eligible_hra_exemption"] = eligible_hra
 		return exemptions
+
+
+@frappe.whitelist()
+def generate_ewb_json(dt, dn):
+	if dt != 'Sales Invoice':
+		frappe.throw(_('e-Way Bill JSON can only be generated from Sales Invoice'))
+
+	dn = dn.split(',')
+
+	ewaybills = []
+	for doc_name in dn:
+		doc = frappe.get_doc(dt, doc_name)
+		if doc.docstatus != 1:
+			frappe.throw(_('e-Way Bill JSON can only be generated from submitted document'))
+
+		if doc.is_return:
+			frappe.throw(_('e-Way Bill JSON cannot be generated for Sales Return as of now'))
+
+		if doc.ewaybill:
+			frappe.throw(_('e-Way Bill already exists for this document'))
+
+		reqd_fields = ['company_gstin', 'company_address', 'customer_address',
+			'shipping_address_name', 'mode_of_transport', 'distance']
+
+		for fieldname in reqd_fields:
+			if not doc.get(fieldname):
+				frappe.throw(_('{} is required to generate e-Way Bill JSON'.format(
+					doc.meta.get_label(fieldname)
+				)))
+
+		if len(doc.company_gstin) < 15:
+			frappe.throw(_('You must be a registered supplier to generate e-Way Bill'))
+
+		data = frappe._dict({
+			"transporterId": "",
+			"TotNonAdvolVal": 0,
+		})
+
+		data.userGstin = data.fromGstin = doc.company_gstin
+		data.supplyType = 'O'
+
+		if doc.invoice_type in ['Regular', 'SEZ']:
+			data.subSupplyType = 1
+		elif doc.invoice_type in ['Export', 'Deemed Export']:
+			data.subSupplyType = 3
+		else:
+			frappe.throw(_('Unsupported Invoice Type for e-Way Bill JSON generation'))
+
+		data.docType = 'INV'
+		data.docDate = frappe.utils.formatdate(doc.posting_date, 'dd/mm/yyyy')
+
+		company_address = frappe.get_doc('Address', doc.company_address)
+		data.fromPincode = validate_pincode(company_address.pincode, 'Company Address')
+		data.fromStateCode = data.actualFromStateCode = validate_state_code(
+			company_address.gst_state_number, 'Company Address')
+
+		billing_address = frappe.get_doc('Address', doc.customer_address)
+		if not doc.billing_address_gstin or len(doc.billing_address_gstin) < 15:
+			data.toGstin = 'URP'
+			set_gst_state_and_state_number(billing_address)
+		else:
+			data.toGstin = doc.billing_address_gstin
+
+		data.toPincode = validate_pincode(billing_address.pincode, 'Customer Address')
+		data.toStateCode = validate_state_code(billing_address.gst_state_number, 'Customer Address')
+
+		if doc.customer_address != doc.shipping_address_name:
+			data.transType = 2
+			shipping_address = frappe.get_doc('Address', doc.shipping_address_name)
+			set_gst_state_and_state_number(shipping_address)
+			data.actualToStateCode = validate_state_code(shipping_address.gst_state_number, 'Shipping Address')
+		else:
+			data.transType = 1
+			data.actualToStateCode = data.toStateCode
+			shipping_address = billing_address
+
+		data.itemList = []
+		data.totalValue = doc.total
+		for attr in ['cgstValue', 'sgstValue', 'igstValue', 'cessValue', 'OthValue']:
+			data[attr] = 0
+
+		gst_accounts = get_gst_accounts(doc.company, account_wise=True)
+		tax_map = {
+			'sgst_account': ['sgstRate', 'sgstValue'],
+			'cgst_account': ['cgstRate', 'cgstValue'],
+			'igst_account': ['igstRate', 'igstValue'],
+			'cess_account': ['cessRate', 'cessValue']
+		}
+		item_data_attrs = ['sgstRate', 'cgstRate', 'igstRate', 'cessRate', 'cessNonAdvol']
+		hsn_wise_charges, hsn_taxable_amount = get_itemised_tax_breakup_data(doc, account_wise=True)
+		for hsn_code, taxable_amount in hsn_taxable_amount.items():
+			item_data = frappe._dict()
+			if not hsn_code:
+				frappe.throw(_('GST HSN Code does not exist for one or more items'))
+			item_data.hsnCode = int(hsn_code)
+			item_data.taxableAmount = taxable_amount
+			item_data.qtyUnit = ""
+			for attr in item_data_attrs:
+				item_data[attr] = 0
+
+			for account, tax_detail in hsn_wise_charges.get(hsn_code, {}).items():
+				account_type = gst_accounts.get(account, '')
+				for tax_acc, attrs in tax_map.items():
+					if account_type == tax_acc:
+						item_data[attrs[0]] = tax_detail.get('tax_rate')
+						data[attrs[1]] += tax_detail.get('tax_amount')
+						break
+				else:
+					data.OthValue += tax_detail.get('tax_amount')
+
+			data.itemList.append(item_data)
+
+		disable_rounded = frappe.db.get_single_value('Global Defaults', 'disable_rounded_total')
+		data.totInvValue = doc.grand_total if disable_rounded else doc.rounded_total
+
+		if doc.distance > 4000:
+			frappe.throw(_('Distance cannot be greater than 4000 kms'))
+
+		data.transDistance = round(doc.distance)
+
+		transport_modes = {
+			'Road': 1,
+			'Rail': 2,
+			'Air': 3,
+			'Ship': 4
+		}
+
+		vehicle_types = {
+			'Regular': 'R',
+			'Over Dimensional Cargo (ODC)': 'O'
+		}
+
+		data.transMode = transport_modes.get(doc.mode_of_transport)
+
+		if doc.mode_of_transport == 'Road':
+			if not doc.gst_transporter_id and not doc.vehicle_no:
+				frappe.throw(_('Either GST Transporter ID or Vehicle No is required if Mode of Transport is Road'))
+			if doc.vehicle_no:
+				data.vehicleNo = doc.vehicle_no.replace(' ', '')
+			if not doc.gst_vehicle_type:
+				frappe.throw(_('Vehicle Type is required if Mode of Transport is Road'))
+			else:
+				data.vehicleType = vehicle_types.get(doc.gst_vehicle_type)
+		else:
+			if not doc.lr_no or not doc.lr_date:
+				frappe.throw(_('Transport Receipt No and Date are mandatory for your chosen Mode of Transport'))
+
+		if doc.lr_no:
+			data.transDocNo = doc.lr_no
+
+		if doc.lr_date:
+			data.transDocDate = frappe.utils.formatdate(doc.lr_date, 'dd/mm/yyyy')
+
+		if doc.gst_transporter_id:
+			validate_gstin_check_digit(doc.gst_transporter_id, label='GST Transporter ID')
+			data.transporterId  = doc.gst_transporter_id
+
+		fields = {
+			"/. -": {
+				'docNo': doc.name,
+				'fromTrdName': doc.company,
+				'toTrdName': doc.customer_name,
+				'transDocNo': doc.lr_no,
+			},
+			"@#/,&. -": {
+				'fromAddr1': company_address.address_line1,
+				'fromAddr2': company_address.address_line2,
+				'fromPlace': company_address.city,
+				'toAddr1': shipping_address.address_line1,
+				'toAddr2': shipping_address.address_line2,
+				'toPlace': shipping_address.city,
+				'transporterName': doc.transporter_name
+			}
+		}
+
+		for allowed_chars, field_map in fields.items():
+			for key, value in field_map.items():
+				if not value:
+					data[key] = ''
+				else:
+					data[key] = re.sub(r'[^\w' + allowed_chars + ']', '', value)
+
+		ewaybills.append(data)
+
+	data = {
+		'version': '1.0.1118',
+		'billLists': ewaybills
+	}
+
+	frappe.local.response.filecontent = json.dumps(data, indent=4, sort_keys=True)
+	frappe.local.response.type = 'download'
+
+	if len(ewaybills) > 1:
+		doc_name = 'Bulk'
+
+	frappe.local.response.filename = '{0}_e-WayBill_Data_{1}.json'.format(doc_name, frappe.utils.random_string(5))
+
+def validate_pincode(pincode, address):
+	pin_not_found = "Pin Code doesn't exist for {}"
+	incorrect_pin = "Pin Code for {} is incorrecty formatted. It must be 6 digits (without spaces)"
+
+	if not pincode:
+		frappe.throw(_(pin_not_found.format(address)))
+
+	pincode = pincode.replace(' ', '')
+	if not pincode.isdigit() or len(pincode) != 6:
+		frappe.throw(_(incorrect_pin.format(address)))
+	else:
+		return int(pincode)
+
+def validate_state_code(state_code, address):
+	no_state_code = "GST State Code not found for {0}. Please set GST State in {0}"
+	if not state_code:
+		frappe.throw(_(no_state_code.format(address)))
+	else:
+		return int(state_code)
+
+def get_gst_accounts(company, account_wise=False):
+	gst_accounts = frappe._dict()
+	gst_settings_accounts = frappe.get_all("GST Account",
+		filters={"parent": "GST Settings", "company": company},
+		fields=["cgst_account", "sgst_account", "igst_account", "cess_account"])
+
+	if not gst_settings_accounts:
+		frappe.throw(_("Please set GST Accounts in GST Settings"))
+
+	for d in gst_settings_accounts:
+		for acc, val in d.items():
+			if not account_wise:
+				gst_accounts.setdefault(acc, []).append(val)
+			elif val:
+				gst_accounts[val] = acc
+
+
+	return gst_accounts

erpnext/regional/report/gstr_1/gstr_1.py

@@ -7,6 +7,7 @@ from frappe import _
 from frappe.utils import flt, formatdate
 from datetime import date
 from six import iteritems
+from erpnext.regional.india.utils import get_gst_accounts
 
 def execute(filters=None):
 	return Gstr1Report(filters).run()
@@ -41,7 +42,7 @@ class Gstr1Report(object):
 
 	def run(self):
 		self.get_columns()
-		self.get_gst_accounts()
+		self.gst_accounts = get_gst_accounts(self.filters.company)
 		self.get_invoice_data()
 
 		if self.invoices:
@@ -117,7 +118,7 @@ class Gstr1Report(object):
 			for item_code, net_amount in self.invoice_items.get(invoice).items() if item_code in items])
 		row += [tax_rate or 0, taxable_value]
 
-		return row, taxable_value
+		return row
 
 	def get_invoice_data(self):
 		self.invoices = frappe._dict()
@@ -239,19 +240,6 @@ class Gstr1Report(object):
 				and frappe.db.get_value(self.doctype, invoice, "export_type") == "Without Payment of Tax":
 					self.items_based_on_tax_rate.setdefault(invoice, {}).setdefault(0, items.keys())
 
-	def get_gst_accounts(self):
-		self.gst_accounts = frappe._dict()
-		gst_settings_accounts = frappe.get_all("GST Account",
-			filters={"parent": "GST Settings", "company": self.filters.company},
-			fields=["cgst_account", "sgst_account", "igst_account", "cess_account"])
-
-		if not gst_settings_accounts:
-			frappe.throw(_("Please set GST Accounts in GST Settings"))
-
-		for d in gst_settings_accounts:
-			for acc, val in d.items():
-				self.gst_accounts.setdefault(acc, []).append(val)
-
 	def get_columns(self):
 		self.tax_columns = [
 			{