Introduction

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 has been designed and developed by National Informatics Centre and it is being rolled out for the use of taxpayers and transporters.  Also, the other modes of e-way bill generation rolled out are SMS based, Android based and API based solutions.

Purpose and Intended Audience

This document aims to explain the operational and technical procedure on how to use API interface to generate the e-Way Bills by the Tax payers or Transporters.
This document is intended for technical experts or software solutions providers of tax payers or transporters, who are already using a computerized system for generating invoices and also generating a large number of invoices.  The best method of EWB generation for such large tax payers, who generate the large number of e-Way Bills, is to build API interface with the E-way bill system. This is site-to-site integration of the systems for e-way Bill generation. In this method, the tax payer system will directly or through GSP request e-way bill to the E-way Bill system while generating invoice and get the e-Way Bill number. This can be printed on the Invoice document and movement of the goods can be started. This avoids duplicate data entry and eliminates data entry mistakes. To use this facility, the tax payers have to request the online for this service.

Scope

This document covers APIs published by E-way bill system. It includes API description with detailed payloads to be exchanged. The details of various APIs for of Authentication, E-way bill generation, Consolidated E-way bill generation, Vehicle No. updation, Cancellation of e-way bill, Rejection of e-way bill are explained in detail along with sample source code in C# .Net for better understanding for the tax payers and transporters.
This document also includes

  • Interface Business Flow Process
  • API format and brief details on key payload parameters.
  • The attribute level description of each API request and response payload.
  • JSON schema and sample JSON payload for respective APIs.
  • API data structure Specification
  • Sample C#.net code
  • Various Master codes and error codes are listed in the Annexures
  • JSON Schema

Related documents to read

  • EWB-API Interface User Document – This is available on the web-site of e-way bill system

URL or Web site address for API for Pre-production
<URL>/ewaybillapi/