[IMP] fiscal localizations: India

task-3272960

closes odoo/documentation#4167

Signed-off-by: Castillo Jonathan (jcs) <jcs@odoo.com>
This commit is contained in:
hapa-odoo 2023-01-16 13:38:57 +00:00 committed by Jonathan
parent 513059fa65
commit f1bad95874
9 changed files with 132 additions and 165 deletions

View File

@ -25,11 +25,26 @@ localization:
* - :guilabel:`Indian E-waybill`
- `l10n_in_edi_ewaybill`
- :ref:`Indian E-way bill integration <india/e-waybill>`
* - :guilabel:`Indian - Accounting Reports`
- `l10n_in_reports`
- Indian tax reports
* - :guilabel:`Indian - Purchase Report(GST)`
- `l10n_in_purchase`
- Indian GST Purchase report
* - :guilabel:`Indian - Sale Report(GST)`
- `l10n_in_sale`
- Indian GST Sale report
* - :guilabel:`Indian - Stock Report(GST)`
- `l10n_in_stock`
- Indian GST Stock report
.. image:: india/india-modules.png
:alt: Indian localization modules
.. _india/e-invoicing:
Indian e-invoicing
==================
e-Invoice system
================
Odoo is compliant with the **Indian Goods and Services Tax (GST) e-Invoice system** requirements.
@ -37,167 +52,148 @@ Odoo is compliant with the **Indian Goods and Services Tax (GST) e-Invoice syste
Indian e-invoicing is available from Odoo 15.0. If needed, :doc:`upgrade
</administration/upgrade>` your database.
Setup
-----
.. _india/e-invoicing-api:
Registration on your NIC e-Invoice web portal
---------------------------------------------
NIC e-Invoice registration
~~~~~~~~~~~~~~~~~~~~~~~~~~
You must register on the **NIC e-Invoice** web portal to get your **API credentials**. You need
these credentials to :ref:`configure your Odoo Accounting app <india/e-invoicing-configuration>`.
You must register on the :abbr:`NIC (National Informatics Centre)` e-Invoice portal to get your
**API credentials**. You need these credentials to :ref:`configure your Odoo Accounting app
<india/e-invoicing-configuration>`.
#. Log in to the NIC e-Invoice web portal at https://einvoice1.gst.gov.in/ by clicking on
:guilabel:`Login` and entering your :guilabel:`Username` and :guilabel:`Password`.
#. Log in to the `NIC e-Invoice portal <https://einvoice1.gst.gov.in/>`_ by clicking
:guilabel:`Login` and entering your :guilabel:`Username` and :guilabel:`Password`;
.. note::
If you have already registered on the NIC Eway Bill Production portal, then you can use the
same login credentials here.
If you are already registered on the NIC portal, you can use the same login credentials.
.. image:: india/e-invoice-system-login.png
:align: center
:alt: Register Odoo ERP system on e-invoice web portal
#. From your dashboard, go to :menuselection:`API Registration --> User Credentials --> Create API
User`.
.. image:: india/e-invoice-create-api-user.png
:align: center
:alt: Click on User Credentials and Create API User
#. After that, you receive an :abbr:`OTP (one-time password)` code to your registered mobile number.
#. Enter the OTP code and click on :guilabel:`Verify OTP`.
.. image:: india/trigger-otp.png
:align: center
:alt: Trigger an OTP to your registered phone number
#. Select :guilabel:`Through GSP` in the first field, select :guilabel:`Tera Software Limited`
as your GSP, and type in a :guilabel:`Username` and :guilabel:`Password` for your API.
#. From the dashboard, go to :menuselection:`API Registration --> User Credentials --> Create API
User`;
#. After that, you should receive an :abbr:`OTP (one-time password)` code on your registered mobile
number. Enter the OTP code and click :guilabel:`Verify OTP`;
#. Select :guilabel:`Through GSP` for the API interface, set :guilabel:`Tera Software Limited` as
GSP, and type in a :guilabel:`Username` and :guilabel:`Password` for your API. Once it is done,
click :guilabel:`Submit`.
.. image:: india/submit-api-registration-details.png
:align: center
:alt: Submit API specific Username and Password
#. Click on :guilabel:`Submit`.
.. _india/e-invoicing-configuration:
Configuration on Odoo
---------------------
Configuration in Odoo
~~~~~~~~~~~~~~~~~~~~~
To set up the e-invoice service, go to :menuselection:`Accounting --> Configuration --> Settings -->
Indian Electronic Invoicing`, and enter the :guilabel:`Username` and :guilabel:`Password`.
To enable the e-Invoice service in Odoo, go to :menuselection:`Accounting --> Configuration -->
Settings --> Indian Electronic Invoicing`, and enter the :guilabel:`Username` and
:guilabel:`Password` previously set for the API.
.. image:: india/e-invoice-setup.png
:align: center
:alt: Setup e-invoice service
.. _india/e-invoicing-journals:
Journals
~~~~~~~~
********
Your default *sales* journal should be already configured correctly. You can check it or configure
other journals by going to :menuselection:`Accounting --> Configuration --> Journals`. Then, open
your *sales* journal, and in the :guilabel:`Advanced Settings` tab, under :guilabel:`Electronic Data
Interchange`, check :guilabel:`E-Invoice (IN)` and :guilabel:`Save`.
.. image:: india/journal-configuration.png
:align: center
:alt: Journal configuration
To automatically send e-Invoices to the NIC e-Invoice portal, you must first configure your *sales*
journal by going to :menuselection:`Accounting --> Configuration --> Journals`, opening your *sales*
journal, and in the :guilabel:`Advanced Settings` tab, under :guilabel:`Electronic Data
Interchange`, enable :guilabel:`E-Invoice (IN)` and save.
.. _india/e-invoicing-workflow:
Workflow
--------
To start invoicing from Odoo, an invoice must be created using the standard invoicing flow, that is,
either from a sales order or the invoice menu in the Accounting application.
.. _india/invoice-validation:
Invoice validation
~~~~~~~~~~~~~~~~~~
Once the invoice is validated, a confirmation message is displayed at the top.
Odoo automatically uploads the JSON-signed file to the government portal after a while. If you want
to process the invoice immediately, you can click on :guilabel:`Process Now`.
Once an invoice is validated, a confirmation message is displayed at the top. Odoo automatically
uploads the JSON-signed file of validated invoices to the NIC e-Invoice portal after some time. If
you want to process the invoice immediately, click :guilabel:`Process now`.
.. image:: india/e-invoice-process.png
:align: center
:alt: Indian e-invoicing confirmation message: "The invoice will be processed asynchronously by
the following E-invoicing service : E-Invoice (IN)"
:alt: Indian e-invoicing confirmation message
.. note::
- You can find the JSON-signed file in the attached files, in the chatter.
- You can check the status of EDI with web-service under the :guilabel:`EDI Document` tab or the
:guilabel:`Electronic invoicing` field.
- You can find the JSON-signed file in the attached files in the chatter.
- You can check the document's :abbr:`EDI (electronic data interchange)` status under the
:guilabel:`EDI Document` tab or the :guilabel:`Electronic invoicing` field of the invoice.
.. _india/invoice-pdf-report:
Invoice PDF Report
Invoice PDF report
~~~~~~~~~~~~~~~~~~
Once the invoice is submitted and validated, you can print the invoice PDF report. The report
includes the :abbr:`IRN (Invoice Reference Number)`, acknowledgment number and date, and QR code.
They certify that the invoice is a valid fiscal document.
Once an invoice is validated and submitted, the invoice PDF report can be printed. The report
includes the :abbr:`IRN (Invoice Reference Number)`, :guilabel:`Ack. No` (acknowledgment number) and
:guilabel:`Ack. Date` (acknowledgment date), and QR code. These certify that the invoice is a valid
fiscal document.
.. image:: india/invoice-report.png
:align: center
:alt: IRN and QR code
.. _india/edi-cancellation:
EDI Cancellation
~~~~~~~~~~~~~~~~
e-Invoice cancellation
~~~~~~~~~~~~~~~~~~~~~~
If you want to cancel an e-invoice, go to the :guilabel:`Other info` tab of the invoice and fill out
the :guilabel:`Cancel reason` and :guilabel:`Cancel remarks` fields. Then, click on
:guilabel:`Request EDI cancellation`. The status of the :guilabel:`Electronic invoicing` field
changes to :guilabel:`To Cancel`.
If you want to cancel an e-Invoice, go to the :guilabel:`Other info` tab of the invoice and fill out
the :guilabel:`Cancel reason` and :guilabel:`Cancel remarks` fields. Then, click :guilabel:`Request
EDI cancellation`. The status of the :guilabel:`Electronic invoicing` field changes to :guilabel:`To
Cancel`.
.. important::
Doing so cancels both the :ref:`E-invoice <india/e-invoicing>` and the :ref:`E-waybill
Doing so cancels both the :ref:`e-Invoice <india/e-invoicing>` and the :ref:`E-Way bill
<india/e-waybill>`.
.. image:: india/e-invoice-cancellation.png
:align: center
:alt: cancel reason and remarks
.. note::
- If you want to abort the cancellation before processing the invoice, then click on
:guilabel:`Call Off EDI Cancellation`.
- Once you request to cancel the e-invoice, Odoo automatically submits the JSON Signed file to
the government portal. You can click on :guilabel:`Process Now` if you want to process the
- If you want to abort the cancellation before processing the invoice, then click :guilabel:`Call
Off EDI Cancellation`.
- Once you request to cancel the e-Invoice, Odoo automatically submits the JSON-signed file to
the NIC e-Invoice portal. You can click :guilabel:`Process now` if you want to process the
invoice immediately.
.. _india/verify-e-invoice:
Verify the e-invoice from the GST
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
GST e-Invoice verification
~~~~~~~~~~~~~~~~~~~~~~~~~~
After submitting an e-invoice, you can also verify the signed invoice from the GST e-Invoice system
website.
After submitting an e-Invoice, you can verify if the invoice is signed from the GST e-Invoice system
website itself.
#. Download the JSON file from the attached files.
#. Open the e-invoice portal: https://einvoice1.gst.gov.in/ and go to :menuselection:`Search -->
Verify Signed Invoice`.
#. Select the JSON file and submit it.
#. Download the JSON file from the attached files. It can be found in the chatter of the related
invoice;
#. Open the `NIC e-Invoice portal <https://einvoice1.gst.gov.in/>`_ and go to
:menuselection:`Search --> Verify Signed Invoice`;
#. Select the JSON file and submit it;
.. image:: india/verify-invoice.png
:align: center
:alt: select the JSON file for verify invoice
#. You can check the verified signed e-invoice here.
If the file is signed, a confirmation message is displayed.
.. image:: india/signed-invoice.png
:align: center
:alt: verified e-invoice
.. _india/e-waybill:
Indian E-waybill
================
E-Way bill
==========
Setup
-----
Odoo is compliant with the **Indian Goods and Services Tax (GST) E-waybill system** requirements.
@ -207,58 +203,40 @@ Odoo is compliant with the **Indian Goods and Services Tax (GST) E-waybill syste
.. _india/e-waybill-api:
API Registration on your NIC E-waybill web portal
-------------------------------------------------
API registration on NIC E-Way bill
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You must register on the **NIC E-waybill** web portal to create your **API credentials**. You need
these credentials to :ref:`configure your Odoo Accounting app <india/e-waybill-configuration>`.
You must register on the :abbr:`NIC (National Informatics Centre)` E-Way bill portal to create your
**API credentials**. You need these credentials to :ref:`configure your Odoo Accounting app
<india/e-waybill-configuration>`.
#. Log in to the NIC E-waybill web portal at https://ewaybillgst.gov.in/ by clicking on
:guilabel:`Login` and entering your :guilabel:`Username` and :guilabel:`Password`.
.. image:: india/e-waybill-system-login.png
:align: center
:alt: E-waybill login
#. From your dashboard, go to :menuselection:`Registration --> For GSP`.
.. image:: india/e-waybill-registration-menu.png
:align: center
:alt: E-waybill registration
#. Click on :guilabel:`Send OTP`; you should receive an :abbr:`OTP (one-time password)` code to your
registered mobile number.
#. Enter the OTP code and click on :guilabel:`Verify OTP`.
.. image:: india/e-waybill-gsp-registration.png
:align: center
:alt: E-waybill OTP verification
#. Check if :guilabel:`Tera Software Limited` is already on the list of registered GSP/ERP. If so,
use this username and password. Otherwise, follow the next steps.
#. Log in to the `NIC E-Way bill portal <https://ewaybillgst.gov.in/>`_ by clicking
:guilabel:`Login` and entering your :guilabel:`Username` and :guilabel:`Password`;
#. From your dashboard, go to :menuselection:`Registration --> For GSP`;
#. Click :guilabel:`Send OTP`. Once you have received the code on your registered mobile number,
enter it and click :guilabel:`Verify OTP`;
#. Check if :guilabel:`Tera Software Limited` is already on the registered GSP/ERP list. If so, use
the username and password used to log in to the NIC portal. Otherwise, follow the next steps;
.. image:: india/e-waybill-gsp-list.png
:align: center
:alt: E-waybill list of registered GSP/ERP
:alt: E-Way bill list of registered GSP/ERP
#. Select :guilabel:`Add/New`, select :guilabel:`Tera Software Limited` as your GSP Name, create a
:guilabel:`Username` and a :guilabel:`Password` for your API, and click on :guilabel:`Add`.
:guilabel:`Username` and a :guilabel:`Password` for your API, and click :guilabel:`Add`.
.. image:: india/e-waybill-registration-details.png
:align: center
:alt: Submit GSP API registration details
.. _india/e-waybill-configuration:
Configuration on Odoo
---------------------
Configuration in Odoo
~~~~~~~~~~~~~~~~~~~~~
To set up the E-waybill service, go to :menuselection:`Accounting --> Configuration --> Settings -->
Indian Electronic WayBill --> Setup E-Waybill`, and enter your :guilabel:`Username` and
To set up the E-Way bill service, go to :menuselection:`Accounting --> Configuration --> Settings
--> Indian Electronic WayBill --> Setup E-Way bill`, and enter your :guilabel:`Username` and
:guilabel:`Password`.
.. image:: india/e-waybill-configuration.png
:align: center
:alt: E-way bill setup odoo
.. _india/e-waybill-workflow:
@ -266,73 +244,62 @@ Indian Electronic WayBill --> Setup E-Waybill`, and enter your :guilabel:`Userna
Workflow
--------
To issue an E-waybill from Odoo, you must create an invoice/bill with the details of the E-waybill
using the standard invoicing/bill flow (either from a sales/purchase order or the invoice/bill menu
in Accounting).
.. _india/e-waybill-send:
Send an E-waybill
~~~~~~~~~~~~~~~~~
Send an E-Way bill
~~~~~~~~~~~~~~~~~~
You can manually send an E-waybill by clicking on :guilabel:`Send E-waybill`.
You can manually send an E-Way bill by clicking :guilabel:`Send E-Way bill`. To send the E-Way bill
automatically when an invoice or a bill is confirmed, enable :guilabel:`E-Way bill (IN)` in your
:ref:`Sales or Purchase journal <india/e-invoicing-journals>`.
.. image:: india/e-waybill-send-button.png
:align: center
:alt: Send E-waybill button on invoices
To send the E-waybill automatically when you confirm an invoice or a bill, enable
:guilabel:`E-waybill (IN)` in your :ref:`Sale/Purchase Journal <india/e-invoicing-journals>`.
.. _india/invoice-validation-e-way:
Invoice validation
~~~~~~~~~~~~~~~~~~
Once you have issued the invoice and clicked on :guilabel:`Send E-waybill`, a confirmation message
is displayed.
.. note::
- Odoo automatically uploads the JSON-signed file to the government portal after a while. You can
click on :guilabel:`Process Now` if you want to process the invoice immediately.
- You can find the JSON-signed file in the attached files in the chatter.
Once an invoice has been issued and sent via :guilabel:`Send E-Way bill`, a confirmation message is
displayed.
.. image:: india/e-waybill-process.png
:align: center
:alt: Indian e-waybill confirmation message: "The invoice will be processed asynchronously by
the following E-waybill service : E-waybill (IN)"
:alt: Indian e-Way bill confirmation message
Invoice PDF Report
.. note::
- You can find the JSON-signed file in the attached files in the chatter.
- Odoo automatically uploads the JSON-signed file to the government portal after some time. Click
:guilabel:`Process now` if you want to process the invoice immediately.
Invoice PDF report
~~~~~~~~~~~~~~~~~~
You can print the invoice PDF report once you have submitted the E-waybill. The report includes the
**E-waybill number** and the **E-waybill validity date**.
You can print the invoice PDF report once you have submitted the E-Way bill. The report includes the
**E-Way bill number** and the **E-Way bill validity date**.
.. image:: india/e-waybill-invoice-report.png
:align: center
:alt: E-way bill acknowledgment number and date
.. _india/e-waybill-cancellation:
E-waybill Cancellation
~~~~~~~~~~~~~~~~~~~~~~
E-Way bill cancellation
~~~~~~~~~~~~~~~~~~~~~~~
If you want to cancel an E-waybill, go to the :guilabel:`eWayBill` tab of the invoice and fill out
the :guilabel:`Cancel reason` and :guilabel:`Cancel remarks` fields. Then, click on
If you want to cancel an E-Way bill, go to the :guilabel:`E-Way bill` tab of the related invoice and
fill out the :guilabel:`Cancel reason` and :guilabel:`Cancel remarks` fields. Then, click
:guilabel:`Request EDI Cancellation`.
.. important::
Doing so cancels both the :ref:`E-invoice <india/e-invoicing>` and the :ref:`E-waybill
<india/e-waybill>`.
Doing so cancels both the :ref:`e-Invoice <india/e-invoicing>` (if applicable) and the
:ref:`E-Way bill <india/e-waybill>`.
.. image:: india/e-waybill-cancellation.png
:align: center
:alt: cancel reason and remarks
:alt: Cancel reason and remarks
.. note::
- If you want to abort the cancellation before processing the invoice, click on :guilabel:`Call
Off EDI Cancellation`.
- If the E-invoice is applicable for this invoice, then it will also be canceled.
- Once you request to cancel the E-waybill, Odoo automatically submits the JSON Signed file to
the government portal. You can click on :guilabel:`Process Now` if you want to process the
invoice immediately.
- If you want to abort the cancellation before processing the invoice, click :guilabel:`Call Off
EDI Cancellation`.
- Once you request to cancel the E-Way bill, Odoo automatically submits the JSON-signed file to
the government portal. You can click :guilabel:`Process Now` if you want to process the invoice
immediately.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB