E-Way Bill System – User Manual for API Interface (Site-to-Site integration)
GST
Dated:- 31-3-2018
E-Way Bill System
User Manual for API Interface (Site-to-Site integration)
1. Introduction
1.1 Background
Introduction of Goods and Services Tax (GST) across India with effect from 1st of July 2017 is a very significant step in the field of indirect tax reforms in India. For quick and easy movement of goods across India without any hindrance, all the check posts across the country are abolished. The GST system provides a provision of e-Way Bill, a document to be carried by the person in charge of conveyance, generated electronically from the common portal. To implement the e-Way Bill system, ICT based solution is required. Hence, as approved by the Goods and Services Tax (GST) Council, a web based solution has been designed and developed by National Informatics Centre and it is being rolled out for the use of taxpayers and transporters. The API interface based mechanism
= = = = = = = =
Plain text (Extract) only
For full text:-Visit the Source
= = = = = = = =
m system to system. This API interface facilitates the tax payers or transporters to enable their automated system to call the EWB system to generate, update and pull the data related to their e-way bills.
2.1 Benefits
These APIs can be used by the Tax Payers or Transporters or GST Suvidha Providers. The tax payers or transporters can have the following benefits by having API interface with their systems:
* Duplicate or double entry of invoice can be avoided. Generally, the employees of the tax payers enter the sales details in their computerised system and generate the invoice. After that they will come to e-way bill system and generate the e-way bill.
* Mistakes while generating e-way bill can be avoided. In a hurry to generate the e-way bill, the employee may do a mistake in data entry of e-way bill form, resulting in generation of incorrect e-way bill.
* Two prints of invoice and e-way bill can be avoided. That is, transporter or driver of the vehicle can be given invoice p
= = = = = = = =
Plain text (Extract) only
For full text:-Visit the Source
= = = = = = = =
or transporter needs to test his/her modified system on the EWB pre-production site with all types of activities/services.
2.3 On-boarding process
* Read the API related documents
* After logging into the e-way bill system, the tax payer or transporter has to select the 'For API' option under 'Registration' menu.
* Enter the request details – domain name, static IP, etc.
* On submission, the EWB system generates the Client_Id, Client_Secret, UserName and Password and displays to the tax payer
* Using this, IT team of the tax payer will change or modify their automated system
* The tax payer will test modified system from his pre-production system with EWB pre-production system
* After thorough testing by the tax payer with all types of activities, at least 200 activities, he will be enabled to move to production.
2.4 Interfacing examples
2.4.1 API Interface for Tax Payer system – One of the ways of interfacing
Note: This is one sample method/process of interfacing th
= = = = = = = =
Plain text (Extract) only
For full text:-Visit the Source
= = = = = = = =
ax payer can decide his process/method as per his business needs. No need to follow this only.
* On hourly basis, Transporter system pulls all the e-waybills assigned to him using EWB API and stores into his system.
* Before movement of goods, transporter enters vehicle no. for his LR and saves in his system
* Now, Transporter system calls EWB system with EBN No. and other details requesting to update Part B of particular e-way bill.
* EWB system after authentication and verification of details, updates vehicle details and gives ACK.
* Transporter system updates this ACK in his system and prints the Trip sheet or manifesto.
* Now, Transporter moves the goods along with this trip sheet or manifesto.
3. List of E-Way Bill API Services/Methods
Sl. No.
API Service
API Description
Response (data)
Applicable To
1.
Authenticate
Authenticate with the credential to access the APIs
Token
Tax Payer, Transporter, Suvidha Provider
2.
Get e-Way Bill
Get the e-Way Bill detai
= = = = = = = =
Plain text (Extract) only
For full text:-Visit the Source
= = = = = = = =
Bill
Generate e-Way Bill
EWB_No, Date
Tax Payer, Transporter, Suvidha Provider
8.
Update Vehicle Number to E-Way Bill
Update new vehicle number for the e-way Bill
EWB_No, Date, Ref_Uniq_No
Tax Payer, Transporter, Suvidha Provider
9.
Cancel E-Way Bill
Cancel the e-Way Bill
EWB_No, Date, Ref_Uniq_No
Tax Payer, Transporter, Suvidha Provider
10.
Reject E-Way Bill
Reject the e-Way Bill
EWB_No, Date, Ref_Uniq_No
Tax Payer, Suvidha Provider
11.
Generate Consolidate E-Way Bill
Generate Consolidated e-Way Bill
CEWB_No, Date
Tax Payer, Transporter, Suvidha Provider
4. Authentication API
To access the API, application should first authenticate using the credentials shared and get the access token issued. Same access token to be used to access subsequent APIs. Access token will be configured to expire after 360 minutes. On expiry, same authentication API needs to be invoked to get new Access Token issued.
The API header information is used for authentication and authoriza
= = = = = = = =
Plain text (Extract) only
For full text:-Visit the Source
= = = = = = = =