feat(india): auto generate/cancel irn on invoice submit/cancel

[nextchamp-saqib]

Added a check in E Invoice Settings

On cancellation, Reason & Remark is by default set as '3' & 'Cancelled by user' respectively

---

Do not allow manual IRN cancellations (ref. #26638)

• It is possible to check "IRN Cancelled" and then cancel the sales invoice while not cancelling the IRN on the portal. This creates confusion while auditing cancelled invoices on the portal

---

• Workaround for fix(e-invoicing): cannot cancel invoice if IRN cancelled on portal #26638

[maharshivpatel]

@nextchamp-saqib cancel_irn_on_cancel function doesn't take into account when irn & ewaybill both are generated, this is due to logic being added on the client-side using einvoice.js instead of on the server-side inside utils.py cancel_irn function. I will also send PR for the same.

I am also working on adding all of the crucial logic on the server-side to avoid these kinds of bugs and enable rapid development.

[maharshivpatel]

Problem: if IRN (e-invoice) cancellation is not successful due to any reason. invoice is still canceled so now the user doesn't have any way to cancel the e-invoice.

some possible errors:

1. It's been more than 24 hours so IRN can't be canceled.
2. Eway Bill was scanned by an officer en route ( or any other reason ) so the e-way bill can't be canceled and due to that IRN can't be canceled
3. GSP application error.

In Case of reason 1 & 2. invoice will never be canceled and a credit note should be created against it.

Suggestions:

1. Instead of using the on_cancel hook to cancel IRN we should use before_cancel so we can prevent invoice cancellation if IRN was not canceled.
2. E-way API is now implemented so we can also use it to auto cancel the e-way bill ( error handling is not working as expected we may have to fix it first ).

[codecov]

Codecov Report

Merging #30873 (650cef3) into develop (e3c0d01) will increase coverage by 0.29%.
The diff coverage is 20.00%.

@@             Coverage Diff             @@
##           develop   #30873      +/-   ##
===========================================
+ Coverage    62.97%   63.26%   +0.29%     
===========================================
  Files          986      986              
  Lines        67417    67523     +106     
===========================================
+ Hits         42453    42719     +266     
+ Misses       24964    24804     -160     

Impacted Files	Coverage Δ
erpnext/hooks.py	100.00% <ø> (ø)
erpnext/regional/india/setup.py	94.24% <ø> (ø)
erpnext/regional/india/e_invoice/utils.py	38.84% <9.67%> (-1.43%)	⬇️
erpnext/controllers/accounts_controller.py	85.59% <100.00%> (+0.02%)	⬆️
.../report/delayed_item_report/delayed_item_report.py	60.78% <0.00%> (-35.30%)	⬇️
erpnext/accounts/doctype/bank/bank.py	71.42% <0.00%> (-14.29%)	⬇️
...rpnext/accounts/doctype/shareholder/shareholder.py	80.00% <0.00%> (-10.00%)	⬇️
...saction/incorrect_balance_qty_after_transaction.py	88.37% <0.00%> (-9.31%)	⬇️
...pnext/stock/doctype/delivery_note/delivery_note.py	66.21% <0.00%> (-2.71%)	⬇️
erpnext/assets/doctype/asset/depreciation.py	85.23% <0.00%> (-2.69%)	⬇️
... and 41 more

[nextchamp-saqib]

if IRN (e-invoice) cancellation is not successful due to any reason
3. GSP application error.

(if error handling is fixed) There will be an error thrown right? The cancellation process would rollback

1. It's been more than 24 hours so IRN can't be canceled
2. Eway Bill was scanned by an officer en route ( or any other reason ) so the e-way bill can't be canceled and due to that IRN can't be canceled

This problem existed even before. The way a user can cancel is to create a Credit Note or check IRN Cancelled manually and then cancel the invoice. This hasn't been documented anywhere and it is confusing.
Let me know if you have a user-friendly solution for this

Instead of using the on_cancel hook to cancel IRN we should use before_cancel so we can prevent invoice cancellation if IRN was not canceled.

If cancellation of IRN is successful and erpnext throws an error then the cancellation will be rolled backed but the IRN will be canceled on the portal.
This will again cause inconsistencies.

This was the reason before_submit or before_cancel hooks aren't used because IRN generation and cancellation must happen as the last step of submission/cancellation

[nextchamp-saqib]

error handling is not working as expected we may have to fix it first

This should fix it frappe/frappe#16855

[nextchamp-saqib]

Hey, @maharshivpatel can you review/test this once again and let me know if you see any problems here?

As per your previous comment, only one problem is unsolved.
If someone has already canceled IRN on the portal and then tries to cancel it in ERPNext again, then he would not be able to do so and will be stuck without being able to cancel the invoice.

[maharshivpatel]

@nextchamp-saqib I will start testing soon meanwhile about that one problem that is unsolved I think we should do something like the below. this will increase the time limit to 72 hours and prevent accidental cancels. it should prevent all of the issues and provide better UX. what are your thoughts on this ?

[maharshivpatel]

from #31100
We can remove the validation altogether. If IRN will be generated on submission, then modifying an invoice value after submission is not possible. So is there a need to keep the validation that some fields of the invoice cannot be modified?

This is only applicable if the user chooses to opt for "auto-generate" functionality.

If the user doesn't opt for "generate on submission" we would still need the validation.

I would also suggest giving preference to manual IRN generation for new ERPNext users.

As they are configuring the system this is the best option as this prevents most mistakes and gives a sense of control while previewing the details that are being sent to IRP.

we should also add an option to show a preview dialog for "generate on submission" and if the user clicks on the primary button then "continue submission" else "rollback the submit.

for example, we recently discovered that a user wrote the wrong item name ( Product A ) with the item code of ( Product B ) and the user added that item on SI as it showed up as ( Product B ) due to the item code.

however, when we generate IRN, the item name would be sent to IRP so the wrong item name ( Product A ) this mistake was prevented as the name ( Product A ) showed up in Preview.

moral of the story is previewing details before sending is great functionality and we should not remove it even for "generate on submission" we can add an option to enable/disable it for UX.

[maharshivpatel]

When API response is "success": false, It throws an error as expected but it doesn't roll back the submit.

[maharshivpatel]

if (self.invoice.doctype, self.invoice.name) not in frappe.flags.currently_saving:
This Prevents E-invoice Request Log ( logging ).
It should log failed request even if it was made using hooks.

[nextchamp-saqib]

Yes, I was aware of this.
The problem is we can't run frappe.db.commit as it will commit all the previous changes to the db and lead to partial submissions in case

If IRN is to be generated on submission and submission is just one single process, then we'll have to prevent commit unless the submission is successful

Do you have any solution for this?

[maharshivpatel]

I am sorry but I don't have an elegant way to share this. You can find relevant code by looking at the line number.

@nextchamp-saqib I think something like this will work instead of preventing commit what if we rollback the changes and then commit.

what I have done is as follows

if success is true it will run log_request else save variables [ url, header, and data ].

if success is false then RequestFailed will be raised and it will call set_failed_status which will rollback changes and then run log_request if It is run from the hook it will commit (with changes rollbacked )

If it was ran by hook get the current committed docstatus from db and set it to invoice docstatus then commit changes. In this case, submit is failed so it won't commit anything (rollback) so we do want to commit . It is safe to commit log_request after set_failed_status committed (rollbacked)

what do you think of this? are there any downsides?

[maharshivpatel]

When API response is "success": false, It throws an error as expected but it doesn't roll back the submit.

If you want to test this manually add IGST & SGST both taxes and then try to submit you will receive an error

[ For Sl. No 1, GST rate of tax is incorrect or not as notified ] but the invoice will still be submitted.

[nextchamp-saqib]

There's one more problem here.
The user may not know if the invoice is eligible for IRN generation. On submission, the user might expect IRN to be generated but due to a field like the GST category not being valid, the IRN won't be generated and the invoice will be submitted.

The solution to this is to have a confirmation dialog if the invoice is eligible for e-invoicing. But editing/customizing the default submit confirmation is not possible as of now
OR have a custom banner message on the top of the form to display e-invoice eligibility.

@maharshivpatel Let me know if you see any other fix for this.

[maharshivpatel]

There's one more problem here. The user may not know if the invoice is eligible for IRN generation. On submission, the user might expect IRN to be generated but due to a field like the GST category not being valid, the IRN won't be generated and the invoice will be submitted.

The solution to this is to have a confirmation dialog if the invoice is eligible for e-invoicing. But editing/customizing the default submit confirmation is not possible as of now OR have a custom banner message on the top of the form to display e-invoice eligibility.

@maharshivpatel Let me know if you see any other fix for this.

@nextchamp-saqib how do you feel about unbinding submit function using jquery and using our own function like as below?

can you give write access to the PR branch? It will be easy to share and compare code changes.

[maharshivpatel]

if automate_irns is true user doesn't get to use generate e-way bill dialog to generate the e-way bill after submitting the doc which is possible behavior and is currently being used in the case of the manual IRN generation process.

[stale]

This pull request has been automatically marked as inactive because it has not had recent activity. It will be closed within 3 days if no further activity occurs, but it only takes a comment to keep a contribution alive :) Also, even if it is closed, you can always reopen the PR when you're ready. Thank you for contributing.