• 18 Jul 2024 05:49 PM
  • Back

New API Features of E-Invoice Interoperable services

news details
The NIC has introduced new API features for interoperable e-Invoice and e-Way Bill services, allowing a single authentication token to be used across multiple portals (e-Invoice1, e-Invoice2, e-Waybill1, e-Waybill2). This update enables access to services and operations, such as IRN generation, cancellation, and e-Waybill creation, across these portals, with APIs designed for cross-portal functionality. Specific error codes and additional header parameters have been introduced for seamless integration. The changes are available for testing on the sandbox portal before moving to production.

The NIC has introduced new API features for interoperable e-Invoice and e-Way Bill services, allowing a single authentication token to be used across multiple portals (e-Invoice1, e-Invoice2, e-Waybill1, e-Waybill2). This update enables access to services and operations, such as IRN generation, cancellation, and e-Waybill creation, across these portals, with APIs designed for cross-portal functionality. Specific error codes and additional header parameters have been introduced for seamless integration. The changes are available for testing on the sandbox portal before moving to production.

Goods and Services Tax

NIC – E-invoice & E-Way Bill Projects
(Dated: 18.07.2024)

A. New API Features of E-Invoice Interoperable services

1. Authentication token can be generated from any of the Portals – e-Invoice1, e-Inovice2, e-Waybill1 or e-Waybill2, and once generated the same token can be used to access services across portals. No need to generate separate token for einvoice1 and einvoice2 as it was before.

2. At e-Invoice1 portal, you can access services of einvoice2 and vice versa. That is, IRNs generated at e-Invoice2 Portal will be available at e-Invoice1 for cancellation and e-waybill generation. Similarly, IRNs generated at e-Invoice1 will be available at e-Invoice2.

3. To access the services of einvoice2, namely 'Get IRN', 'Cancel IRN' and 'Eway bill by IRN' from einvoice1, the URL and end points are same as of einvoice1, an additional header parameter 'irp' with value 'NIC2' needs to be passed, which indicates that service requested is from e-Invoice2. Similarly 'irp' should be 'NIC1' to access these services of e-Invoice1 from e-Invoice2.

In the absence of 'irp' header parameter, APIs will work for the data available locally or the URL accessed.

4. APIs available for criss-cross operations between these sites are.

    • Get IRN Details
    • Cancel IRN
    • Get IRN Details by Doc. Details
    • Generate e-Waybill by IRN
    • Get e-Waybill details by IRN

5. The following error code has been added

3098Invalid IRP code

6. Please visit https://einv-apisandbox.nic.in/ for changes in API Specification. Login to the sandbox portal for testing URLs.

5. Please test these APIs on sandbox, before moving to the production.

B. API Features of E-Way Bill Interoperable services

1. For direct e-Waybill operations, e-Waybill1 and e-Waybill2 API systems are made operational in sandbox environment. e-Waybill2 runs in parallel with e-Waybill1 System, but with the following critical functionalities.

    • Generate E-Way Bill
    • Update Vehicle Details
    • Update Transporter Details
    • Get E-Way Bill
    • Cancel E-Way Bill

2. Authentication token can be common for all Portals – e-Invoice1, e-Inovice2, e-Waybill1 or e-Waybill2.

3. At e-Waybill1 System, you can access the services namely 'Get E-way bill', 'Part B updation' of e-Waybill2 System and vice versa. That is, e-Waybills generated at e-Waybill2 System can be retrieved and part B can be updated from e-Waybill1 System. Similarly, e-waybills of e-Waybill1 can be retrieved and part B can be updated from e-Waybill 2. e-Waybill2 system synchronises the e-Waybill details with e-Waybill1 System within a few seconds.

4. APIs available for criss-cross operations between these sites are.

    • Get E way bill
    • Part B updation

5. New Error Codes

117This option is not enabled in Eway Bill2
118Try after 5 minutes
444This Ewaybill cannot be cancelled as it is generated from NIC1
445This Ewaybill cannot be cancelled as it is generated from NIC2
446Transport details cannot be updated here as it is generated from NIC1
447Transport details cannot be updated here as it is generated from NIC2
448Part B cannot be updated as this Ewaybill Part A is generated in NIC1
449Part B cannot be updated as this Ewaybill Part A is generated in NIC2
452Consolidate Ewaybill cannot be generated as this Ewaybill Part A is generated in NIC2

6. Please visit https://einv-apisandbox.nic.in/ for changes in API Specification. Login to the sandbox portal for testing URLs.

7. Please test these APIs on sandbox, before moving to the production.