feat: e-Waybill for purchase invoice (#350)

Co-authored-by: Smit Vora <[email protected]>
Co-authored-by: ljain112 <[email protected]>

india_compliance/gst_india/client_scripts/e_waybill_actions.js

@@ -1,9 +1,5 @@
 function setup_e_waybill_actions(doctype) {
-    if (
-        !gst_settings.enable_e_waybill ||
-        (doctype == "Delivery Note" && !gst_settings.enable_e_waybill_from_dn)
-    )
-        return;
+    if (!gst_settings.enable_e_waybill) return;
 
     frappe.ui.form.on(doctype, {
         mode_of_transport(frm) {
@@ -31,8 +27,7 @@ function setup_e_waybill_actions(doctype) {
             if (
                 frm.doc.docstatus != 1 ||
                 frm.is_dirty() ||
-                !is_e_waybill_applicable(frm) ||
-                (frm.doctype === "Delivery Note" && !frm.doc.customer_address)
+                !is_e_waybill_applicable(frm)
             )
                 return;
 
@@ -132,11 +127,9 @@ function setup_e_waybill_actions(doctype) {
         },
         async on_submit(frm) {
             if (
-                // threshold is only met for Sales Invoice
+                frm.doctype != "Sales Invoice" ||
                 !has_e_waybill_threshold_met(frm) ||
                 frm.doc.ewaybill ||
-                frm.doc.is_return ||
-                frm.doc.is_debit_note ||
                 !india_compliance.is_api_enabled() ||
                 !gst_settings.auto_generate_e_waybill ||
                 is_e_invoice_applicable(frm) ||
@@ -672,11 +665,10 @@ function show_update_transporter_dialog(frm) {
 }
 
 async function show_extend_validity_dialog(frm) {
-    const shipping_address = await frappe.db.get_doc(
+    const destination_address = await frappe.db.get_doc(
         "Address",
-        frm.doc.shipping_address_name || frm.doc.customer_address
+        get_destination_address_name(frm)
     );
-
     const is_in_movement = "eval: doc.consignment_status === 'In Movement'";
     const is_in_transit = "eval: doc.consignment_status === 'In Transit'";
 
@@ -749,23 +741,23 @@ async function show_extend_validity_dialog(frm) {
                 label: "Address Line1",
                 fieldname: "address_line1",
                 fieldtype: "Data",
-                default: shipping_address.address_line1,
+                default: destination_address.address_line1,
                 depends_on: is_in_transit,
                 mandatory_depends_on: is_in_transit,
             },
             {
                 label: "Address Line2",
                 fieldname: "address_line2",
                 fieldtype: "Data",
-                default: shipping_address.address_line2,
+                default: destination_address.address_line2,
                 depends_on: is_in_transit,
                 mandatory_depends_on: is_in_transit,
             },
             {
                 label: "Address Line3",
                 fieldname: "address_line3",
                 fieldtype: "Data",
-                default: shipping_address.city,
+                default: destination_address.city,
                 depends_on: is_in_transit,
                 mandatory_depends_on: is_in_transit,
             },
@@ -777,22 +769,22 @@ async function show_extend_validity_dialog(frm) {
                 fieldname: "current_place",
                 fieldtype: "Data",
                 reqd: 1,
-                default: shipping_address.city,
+                default: destination_address.city,
             },
             {
                 label: "Current Pincode",
                 fieldname: "current_pincode",
                 fieldtype: "Data",
                 reqd: 1,
-                default: shipping_address.pincode,
+                default: destination_address.pincode,
             },
             {
                 label: "Current State",
                 fieldname: "current_state",
                 fieldtype: "Autocomplete",
                 options: frappe.boot.india_state_options.join("\n"),
                 reqd: 1,
-                default: shipping_address.state,
+                default: destination_address.state,
             },
             {
                 fieldtype: "Section Break",
@@ -855,19 +847,20 @@ function is_e_waybill_valid(frm) {
 }
 
 function has_e_waybill_threshold_met(frm) {
-    if (
-        frm.doc.doctype == "Sales Invoice" &&
-        Math.abs(frm.doc.base_grand_total) >= gst_settings.e_waybill_threshold
-    )
+    if (Math.abs(frm.doc.base_grand_total) >= gst_settings.e_waybill_threshold)
         return true;
 }
 
 function is_e_waybill_applicable(frm) {
-    // means company is Indian and not Unregistered
     if (
+        // means company is Indian and not Unregistered
         !frm.doc.company_gstin ||
-        (frm.doctype === "Sales Invoice" &&
-            frm.doc.company_gstin === frm.doc.billing_address_gstin)
+        !gst_settings.enable_e_waybill ||
+        !(
+            is_e_waybill_applicable_on_sales_invoice(frm) ||
+            is_e_waybill_applicable_on_purchase_invoice(frm) ||
+            is_e_waybill_applicable_on_delivery_note(frm)
+        )
     )
         return;
 
@@ -886,9 +879,11 @@ function can_extend_e_waybill(frm) {
     const valid_upto = frm.doc.__onload?.e_waybill_info?.valid_upto;
     const extend_after = get_hours(valid_upto, -8);
     const extend_before = get_hours(valid_upto, 8);
+    const now = frappe.datetime.now_datetime();
 
     if (
-        extend_after < frappe.datetime.now_datetime() < extend_before &&
+        extend_after < now &&
+        now < extend_before &&
         frm.doc.gst_transporter_id != frm.doc.company_gstin
     )
         return true;
@@ -907,6 +902,33 @@ function is_e_waybill_cancellable(frm) {
     );
 }
 
+function is_e_waybill_applicable_on_sales_invoice(frm) {
+    return (
+        frm.doctype == "Sales Invoice" &&
+        frm.doc.company_gstin !== frm.doc.billing_address_gstin &&
+        frm.doc.customer_address &&
+        !frm.doc.is_return &&
+        !frm.doc.is_debit_note
+    );
+}
+
+function is_e_waybill_applicable_on_delivery_note(frm) {
+    return (
+        frm.doctype == "Delivery Note" &&
+        frm.doc.customer_address &&
+        gst_settings.enable_e_waybill_from_dn
+    );
+}
+
+function is_e_waybill_applicable_on_purchase_invoice(frm) {
+    return (
+        frm.doctype == "Purchase Invoice" &&
+        frm.doc.supplier_address &&
+        frm.doc.company_gstin !== frm.doc.supplier_gstin &&
+        gst_settings.enable_e_waybill_from_pi
+    );
+}
+
 function is_e_waybill_generated_using_api(frm) {
     const e_waybill_info = frm.doc.__onload && frm.doc.__onload.e_waybill_info;
     return e_waybill_info && e_waybill_info.created_on;
@@ -1021,3 +1043,14 @@ function get_e_waybill_file_name(docname) {
 function set_primary_action_label(dialog, primary_action_label) {
     dialog.get_primary_btn().removeClass("hide").html(primary_action_label);
 }
+
+function get_destination_address_name(frm) {
+    if (frm.doc.doctype == "Purchase Invoice") {
+        if (frm.doc.is_return) return frm.doc.supplier_address;
+        return frm.doc.shipping_address_name || frm.doc.billing_address;
+    } else {
+        if (frm.doc.is_return)
+            return frm.doc.dispatch_address_name || frm.doc.company_address;
+        return frm.doc.shipping_address_name || frm.doc.customer_address;
+    }
+}

india_compliance/gst_india/client_scripts/purchase_invoice.js

@@ -1,4 +1,23 @@
-frappe.ui.form.on("Purchase Invoice", {
+const DOCTYPE = "Purchase Invoice";
+setup_e_waybill_actions(DOCTYPE);
+
+frappe.ui.form.on(DOCTYPE, {
+    after_save(frm) {
+        if (
+            frm.doc.docstatus ||
+            frm.doc.supplier_address ||
+            !is_e_waybill_applicable(frm)
+        )
+            return;
+
+        frappe.show_alert(
+            {
+                message: __("Supplier Address is required to create e-Waybill"),
+                indicator: "yellow",
+            },
+            10
+        );
+    },
     refresh(frm) {
         if (
             frm.doc.docstatus !== 1 ||

india_compliance/gst_india/constants/custom_fields.py

@@ -370,7 +370,7 @@
             "fieldname": "gst_section",
             "label": "GST Details",
             "fieldtype": "Section Break",
-            "insert_after": "language",
+            "insert_after": "gst_vehicle_type",
             "print_hide": 1,
             "collapsible": 1,
         },
@@ -726,19 +726,9 @@
         "print_hide": 1,
         "translatable": 0,
     },
-    {
-        "fieldname": "ewaybill",
-        "label": "e-Waybill No.",
-        "fieldtype": "Data",
-        "depends_on": "eval: doc.docstatus === 1 || doc.ewaybill",
-        "allow_on_submit": 1,
-        "insert_after": "customer_name",
-        "translatable": 0,
-        "no_copy": 1,
-    },
 ]
 
-E_WAYBILL_SI_FIELDS = [
+E_WAYBILL_INV_FIELDS = [
     {
         "fieldname": "transporter_info",
         "label": "Transporter Info",
@@ -814,23 +804,39 @@
         "default": "Today",
         "print_hide": 1,
     },
-    {
-        "fieldname": "e_waybill_status",
-        "label": "e-Waybill Status",
-        "fieldtype": "Select",
-        "insert_after": "ewaybill",
-        "options": "\nPending\nGenerated\nCancelled\nNot Applicable",
-        "print_hide": 1,
-        "no_copy": 1,
-        "translatable": 1,
-        "allow_on_submit": 1,
-        "depends_on": "eval:doc.docstatus === 1 && (!doc.ewaybill || in_list(['','Pending', 'Not Applicable'], doc.e_waybill_status))",
-        "read_only_depends_on": "eval:doc.e_waybill_status === 'Generated' && doc.ewaybill",
-    },
     *E_WAYBILL_DN_FIELDS,
 ]
 
+sales_e_waybill_field = {
+    "fieldname": "ewaybill",
+    "label": "e-Waybill No.",
+    "fieldtype": "Data",
+    "depends_on": "eval: doc.docstatus === 1 || doc.ewaybill",
+    "allow_on_submit": 1,
+    "translatable": 0,
+    "no_copy": 1,
+    "insert_after": "customer_name",
+}
+
+e_waybill_status_field = {
+    "fieldname": "e_waybill_status",
+    "label": "e-Waybill Status",
+    "fieldtype": "Select",
+    "insert_after": "ewaybill",
+    "options": "\nPending\nGenerated\nCancelled\nNot Applicable",
+    "print_hide": 1,
+    "no_copy": 1,
+    "translatable": 1,
+    "allow_on_submit": 1,
+    "depends_on": "eval:doc.docstatus === 1 && (!doc.ewaybill || in_list(['','Pending', 'Not Applicable'], doc.e_waybill_status))",
+    "read_only_depends_on": "eval:doc.e_waybill_status === 'Generated' && doc.ewaybill",
+}
+
+purchase_e_waybill_field = {**sales_e_waybill_field, "insert_after": "supplier_name"}
+
 E_WAYBILL_FIELDS = {
-    "Sales Invoice": E_WAYBILL_SI_FIELDS,
-    "Delivery Note": E_WAYBILL_DN_FIELDS,
+    "Sales Invoice": E_WAYBILL_INV_FIELDS
+    + [sales_e_waybill_field, e_waybill_status_field],
+    "Delivery Note": E_WAYBILL_DN_FIELDS + [sales_e_waybill_field],
+    "Purchase Invoice": E_WAYBILL_INV_FIELDS + [purchase_e_waybill_field],
 }

india_compliance/gst_india/constants/e_waybill.py

@@ -10,7 +10,26 @@
 # }
 #
 # DATETIME_FORMAT = "%d/%m/%Y %I:%M:%S %p"
+selling_address = {
+    "bill_from": "company_address",
+    "bill_to": "customer_address",
+    "ship_from": "dispatch_address_name",
+    "ship_to": "shipping_address_name",
+}
+
+buying_address = {
+    "bill_from": "supplier_address",
+    "bill_to": "billing_address",
+    "ship_from": "supplier_address",
+    "ship_to": "shipping_address",
+}
 
+ADDRESS_FIELDS = {
+    "Sales Invoice": selling_address,
+    "Purchase Invoice": buying_address,
+    "Delivery Note": selling_address,
+}
+PERMITTED_DOCTYPES = list(ADDRESS_FIELDS.keys())
 
 CANCEL_REASON_CODES = {
     "Duplicate": "1",

india_compliance/gst_india/doctype/gst_settings/gst_settings.json

@@ -22,6 +22,7 @@
   "e_waybill_section",
   "enable_e_waybill",
   "enable_e_waybill_from_dn",
+  "enable_e_waybill_from_pi",
   "fetch_e_waybill_data",
   "attach_e_waybill_print",
   "column_break_10",
@@ -238,6 +239,13 @@
    "fieldtype": "Check",
    "label": "Autofill Party Information based on GSTIN"
   },
+  {
+   "default": "0",
+   "depends_on": "eval: doc.enable_e_waybill",
+   "fieldname": "enable_e_waybill_from_pi",
+   "fieldtype": "Check",
+   "label": "Enable e-Waybill Generation from Purchase Invoice"
+  },
   {
    "collapsible": 1,
    "fieldname": "uom_mapping_section",