# Introduction

Masters India provides e-Way Bills solution and API.

**Background**

The 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.&#x20;

The GST system provides a provision of an 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, an 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 the 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 the API interface to generate e-Way Bills by Taxpayers or Transporters.

\
This document is intended for technical experts or software solutions providers of taxpayers 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 taxpayers, who generate a large number of e-way Bills, is to build an API interface with the E-way bill system. This is site-to-site integration of the systems for e-way Bill generation.&#x20;

In this method, the taxpayer system will directly or through GSP request an e-way bill to the E-way Bill system while generating an invoice and getting 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 taxpayers have to request the online for this service.

**Scope**

This document covers APIs published by the E-way bill system. It includes an API description with detailed payloads to be exchanged. The details of various APIs for Authentication, E-way bill generation, Consolidated E-way bill generation, Vehicle No. updation, Cancellation of e-way bill, and Rejection of e-way bill are explained in detail along with sample source code in C# .Net for better understanding for the taxpayers 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
* Various Master codes and error codes are listed in the Annexures
* JSON Schema


# Environments

Masters India Provides 2 environments for customers.

| Website URL                                              | API URL                                                      | Environment |
| -------------------------------------------------------- | ------------------------------------------------------------ | ----------- |
| [https://sandb-edoc.mastersindia.co](/eway/environments) | [https://sandb-api.edoc.mastersindia.co](/eway/environments) | SANDBOX     |
| [https://edoc.mastersindia.co](/eway/environments)       | [https://router.mastersindia.co](/eway/environments)         | PRODUCTION  |

* **Website URL** - The Frontend site from where the onboarding/registration can be done
* **API URL** - The Backend URL from where the APIs are exposed for you to integrate


# Authentication

This section showcases how the 2 types of Authentication mechanisms we support.

{% content-ref url="/pages/QTBvBTZKdlcFPIxYx7zm" %}
[Access Tokens](/eway/authentication/access-tokens)
{% endcontent-ref %}

{% content-ref url="/pages/Rp40nFRaenlHc1eT9D6e" %}
[API KEY](/eway/authentication/api-key)
{% endcontent-ref %}

## Authentication Header

### Access Token&#x20;

If you have chosen the access token approach then for authentication to work you will need to pass the token in request **headers** in the following manner

| Paramater     | Value                    | Description                                                                                              |
| ------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- |
| Authorization | JWT **\<access\_token>** | **JWT** remains constant following by a space and then the access token received from the associated API |

### API Key

If you have chosen the API key approach then for authentication to work you will need to pass the token in request **headers** in the following manner

| Paramater | Value       | Description                                                |
| --------- | ----------- | ---------------------------------------------------------- |
| api\_key  | \<api\_key> | Pass the API key generated from the UI as is in the header |


# Access Tokens

This page shows how to get the authentication credentials using the access token and refresh token policies.

Masters India supports access-token-based authentication. After a user login request, our API generates an access\_token and a refresh token to a user after validating his credentials.&#x20;

### Access Token

The Access token key can be used in subsequent requests but expires after 24 hours which must be requested again by re-initiating a login or call the token-refresh API. The Access token once generated is valid for 24 hours and the refresh token is valid for many days. This token need to be passed in the subsequent requests to avoid permission issues.

The key needs to be passed as a request parameter. To generate the Authorization token by clicking on the Send button. Once the Token Is generated. We need to the token in **Authorization** header with the prefix **JWT** so the token will be passed as **JWT \<token>**

## Get Access token API

### Request Method

POST

### Request Path

```
{{API_URL}}/api/v1/token-auth/
```

### Request Body

| Parameter | Value        | Description                |
| --------- | ------------ | -------------------------- |
| username  | sample\_user | username                   |
| password  | 1234Pass     | password of the given user |

### Response Body

#### 200 (OK)

| Parameter | Value | Description                   |
| --------- | ----- | ----------------------------- |
| token     | ''    | access token (24 hr validity) |

#### 206 (Invalid Credentials)

| Parameter | Value                                      | Description |
| --------- | ------------------------------------------ | ----------- |
| error     | "Unable to login with provided credential" |             |

#### 400 (Invalid Params)

| Parameter | Value              | Description |
| --------- | ------------------ | ----------- |
| username  | \['missing field'] |             |


# API KEY

This page showcases how you can use API Key as an authentication mechanism

Another solution that we provide is the API key appoarch. This API Key can be generated by logging to the UI and going to **profile settings > API Keys**

<figure><img src="https://1687566248-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxMHHPbOOYSSJiJR6wtVq%2Fuploads%2Fa97PyErpHErwBq3uEy2s%2Fapi_key.png?alt=media&amp;token=ca43056b-0b7e-4a43-bf3a-1b60252f3b4c" alt=""><figcaption></figcaption></figure>

Under API you will find the option to generate API Key, click on generate and you have the API key available.  This is a permanent key which can be re-generated or deactivated as per user prefernce.


# Generate E-Way Bill

Generate E-way bill  API

### Request Method

POST

### Request Path

```
{{API_URL}}/api/v1/ewayBillsGenerate/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Body

The request body description for the API can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/generate_eway_bill_api_v_1_ewayBillsGenerate__post).

#### Sample Request

```json
{
    "userGstin": "XXXXXXXXXXXXXXX",
    "supply_type": "outward",
    "sub_supply_type": "Supply",
    "sub_supply_description": "",
    "document_type": "Tax Invoice",
    "document_number": "IMP/23/032",
    "document_date": "22/06/2023",
    "gstin_of_consignor": "XXXXXXXXXXXXXXX",
    "legal_name_of_consignor": "Welton",
    "address1_of_consignor": "The Taj Mahal Palace,Apollo Bandar",
    "address2_of_consignor": "Colaba,Mumbai",
    "place_of_consignor": "Mumbai",
    "pincode_of_consignor": 400001,
    "state_of_consignor": "UTTARAKHAND",
    "actual_from_state_name": "MAHARASHTRA",
    "gstin_of_consignee": "XXXXXXXXXXXXXXX",
    "legal_name_of_consignee": "Sthuthya",
    "address1_of_consignee": "Shree Nilaya",
    "address2_of_consignee": "Dasarahosahalli",
    "place_of_consignee": "Dehradun",
    "pincode_of_consignee": 248001,
    "state_of_supply": "UTTARAKHAND",
    "actual_to_state_name": "UTTARAKHAND",
    "transaction_type": 3,
    "other_value": 0,
    "total_invoice_value": 560,
    "taxable_amount": 500,
    "cgst_amount": 30,
    "sgst_amount": 30,
    "igst_amount": 0,
    "cess_amount": 0,
    "cess_nonadvol_value": 0,
    "transporter_id": "XXXXXXXXXXXXXXX",
    "transporter_name": "",
    "transporter_document_number": "",
    "transporter_document_date": "",
    "transportation_mode": "Road",
    "transportation_distance": "80",
    "vehicle_number": "WXX2121",
    "vehicle_type": "Regular",
    "generate_status": 1,
    "data_source": "erp",
    "user_ref": "",
    "location_code": "",
    "eway_bill_status": "ABC",
    "auto_print": "N",
    "email": "",
    "delete_record": "N",
    "itemList": [
        {
            "product_name": "Wheat",
            "product_description": "Wheat",
            "hsn_code": "1001",
            "quantity": 1,
            "unit_of_product": "BOX",
            "cgst_rate": 6,
            "sgst_rate": 6,
            "igst_rate": 0,
            "cess_rate": 0,
            "cessNonAdvol": 0,
            "taxable_amount": 100
        },
        {
            "product_name": "Wheat",
            "product_description": "Wheat",
            "hsn_code": "1001",
            "quantity": 1,
            "unit_of_product": "BOX",
            "cgst_rate": 6,
            "sgst_rate": 6,
            "igst_rate": 0,
            "cess_rate": 0,
            "cessNonAdvol": 0,
            "taxable_amount": 100
        }
    ]
}
```

### Response Body

#### 200 (OK)

The response description for success can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/generate_eway_bill_api_v_1_ewayBillsGenerate__post).

#### Sample Response

```json
{
  "results": {
    "message": {
      "ewayBillNo": 301009218802,
      "ewayBillDate": "15/09/2023 02:36:00 PM",
      "validUpto": "24/09/2023 11:59:00 PM",
      "alert": "",
      "error": false,
      "url": "sandb-api.mastersindia.co/api/v1/detailPrintPdf/anVsX3NlcF8yMDIzLTI0-65041f35112f30081f9e0b3d/"
    },
    "status": "Success",
    "code": 200,
    "requestId": "ERP1694768948_IMP/23/032"
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "437: Invalid Supplier ship from State Code for the given pincode.",
    "status": "No Content",
    "code": 204,
    "nic_code": "437"
  }
}
```


# Cancel E-Way Bill

Cancel E-way bill  API

### Request Method

POST

### Request Path

```
{{API_URL}}/api/v1/ewayBillCancel/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Body

The request body description for the API can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/cancel_eway_bill_api_v_1_ewayBillCancel__post).

#### Sample Request

```json
{
"userGstin":"XXXXXXXXXXXXXXX",
"eway_bill_number": 361003223321,
"reason_of_cancel": "Others",
"cancel_remark": "Cancelled the order",
"data_source":"erp"
}
```

### Response Body

#### 200 (OK)

The response description for success can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/cancel_eway_bill_api_v_1_ewayBillCancel__post).

#### Sample Response

```json
{
  "results": {
    "message": {
      "ewayBillNo": "301009218802",
      "cancelDate": "15/09/2023 02:40:00 PM",
      "error": false
    },
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "312: This eway bill is either not generated by you or cancelled",
    "status": "No Content",
    "code": 204,
    "nic_code": "312"
  }
}
```


# Update Part-B

Update part B API

### Request Method

POST

### Request Path

```
{{API_URL}}/api/v1/updateVehicleNumber/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Body

The request body description for the API can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/update_part_b_api_v_1_updateVehicleNumber__post).

#### Sample Request

```json
{
"userGstin":"XXXXXXXXXXXXXXX",
"eway_bill_number": 321009218808,
"vehicle_number": "JJK8977",
"vehicle_type":"r",
"place_of_consignor": "Noida",
"state_of_consignor": "Uttar Pradesh",
"reason_code_for_vehicle_updation": "due to break down",
"reason_for_vehicle_updation": "",
"transporter_document_number": "14456",
"transporter_document_date": "25/06/2023",
"mode_of_transport": 1,
"data_source":""
}
```

### Response Body

#### 200 (OK)

The response description for success can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/update_part_b_api_v_1_updateVehicleNumber__post).

#### Sample Response

```json
{
  "results": {
    "message": {
      "vehUpdDate": "15/09/2023 02:45:00 PM",
      "validUpto": "24/09/2023 11:59:00 PM",
      "error": false,
      "url": "https://sandb-api.mastersindia.co/api/v1/detailPrintPdf/anVsX3NlcF8yMDIzLTI0-65042126bc6d8306741fdcf8/"
    },
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "362: Transporter document date cannot be earlier than the invoice date",
    "status": "No Content",
    "code": 204,
    "nic_code": "362"
  }
}
```


# Extend Validity of E-Way Bill

Extend Validity of E-Way Bill API

### Request Method

POST

### Request Path

```
{{API_URL}}/api/v1/ewayBillValidityExtend/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Body

The request body description for the API can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/extend_eway_bill_api_v_1_ewayBillValidityExtend__post).

#### Sample Request

```json
{
    "userGstin": "XXXXXXXXXXXXXXX",
    "eway_bill_number": 331009219156,
    "vehicle_number": "KA12TR1234",
    "place_of_consignor": "Dehradun",
    "state_of_consignor": "UTTARAKHAND",
    "remaining_distance": 20,
    "transporter_document_number": "123",
    "transporter_document_date": "25/06/2023",
    "mode_of_transport": "5",
    "extend_validity_reason": "Natural Calamity",
    "extend_remarks": "Flood",
    "consignment_status": "T",
    "from_pincode": 248001,
    "transit_type": "W",
    "address_line1": "HUBLI",
    "address_line2": "HUBLI",
    "address_line3": "HUBLI"
}
```

### Response Body

#### 200 (OK)

The response description for success can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/extend_eway_bill_api_v_1_ewayBillValidityExtend__post).

#### Sample Response

```json
{
  "results": {
    "message": {
      "ewayBillNo": "331009219156",
      "updatedDate": "20/09/2023 07:07:00 PM",
      "validUpto": "21/09/2023 11:59:00 PM",
      "error": false,
      "url": "https://sandb-api.mastersindia.co/api/v1/detailPrintPdf/anVsX3NlcF8yMDIzLTI0-650af67d1b6b83a4653b2870/"
    },
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "301: Invalid eway bill number",
    "status": "No Content",
    "code": 204,
    "nic_code": "301"
  }
}
```


# Update Transporter

Update Transporter Id API

### Request Method

POST

### Request Path

```
{{API_URL}}/api/v1/transporterIdUpdate/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Body

The request body description for the API can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/update_transporter_id_api_v_1_transporterIdUpdate__post).

#### Sample Request

```json
{
    "userGstin": "XXXXXXXXXXXXXXX",
    "eway_bill_number": 321009218808,
    "transporter_id": "XXXXXXXXXXXXXXX",
    "transporter_name": "MS Uttarayan"
}
```

### Response Body

#### 200 (OK)

The response description for success can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/update_transporter_id_api_v_1_transporterIdUpdate__post).

#### Sample Response

```json
{
  "results": {
    "message": {
      "ewayBillNo": "321009218808",
      "transporterId": "XXXXXXXXXXXXXXX",
      "transUpdateDate": "15/09/2023 03:05:00 PM",
      "error": false
    },
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "222: Invalid Transporter Id",
    "status": "No Content",
    "code": 204,
    "nic_code": "222"
  }
}
```


# Reject E-Way Bill

Reject E-Way Bill API

### Request Method

POST

### Request Path

```
{{API_URL}}/api/v1/ewayBillReject/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Body

The request body description for the API can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/reject_eway_bill_api_v_1_ewayBillReject__post).

#### Sample Request

```json
{
    "userGstin":"XXXXXXXXXXXXXXX",
    "eway_bill_number": 371009218816,
    "data_source":""
}
```

### Response Body

#### 200 (OK)

The response description for success can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/reject_eway_bill_api_v_1_ewayBillReject__post).

#### Sample Response

```json
{
  "results": {
    "message": {
      "ewayBillNo": "371009218816",
      "ewbRejectedDate": "15/09/2023 03:24:00 PM",
      "error": false
    },
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "344: Invalid eway bill number",
    "status": "No Content",
    "code": 204,
    "nic_code": "344"
  }
}
```


# Generate Consolidate E-Way Bill

Generate Consolidate E Way Bill API

### Request Method

POST

### Request Path

```
{{API_URL}}/api/v1/consolidatedEwayBillsGenerate/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Body

The request body description for the API can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/generate_consolidate_eway_bill_api_v_1_consolidatedEwayBillsGenerate__post).

#### Sample Request

```json
{
    "userGstin": "XXXXXXXXXXXXXXX",
    "place_of_consignor": "RAJPURA",
    "state_of_consignor": "PUNJAB",
    "vehicle_number": "JJK8977",
    "mode_of_transport": 2,
    "transporter_document_number": 14456,
    "transporter_document_date": "25/06/2023",
    "data_source": "erp",
    "list_of_eway_bills": [
        {
            "eway_bill_number": "371003223324"
        },
        {
            "eway_bill_number": "341003223325"
        }
    ]
}
```

### Response Body

#### 200 (OK)

The response description for success can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/generate_consolidate_eway_bill_api_v_1_consolidatedEwayBillsGenerate__post).

#### Sample Response

```json
{
  "results": {
    "message": {
      "cEwbNo": "3210007391",
      "cEwbDate": "15/09/2023 03:32:00 PM",
      "error": false,
      "url": "sandb-api.mastersindia.co/api/v1/consolidatePrintPdf/anVsX3NlcF8yMDIzLTI0-65042c58112f30081f9e0b43"
    },
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "224: Invalid Transaction Date",
    "status": "No Content",
    "code": 204,
    "nic_code": "224"
  }
}
```


# Regenerate Consolidate E-Way Bill

Regenerate Consolidate E Way Bill API

### Request Method

POST

### Request Path

```
{{API_URL}}/api/v1/consolidatedEwayBillsRegenerate/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Body

The request body description for the API can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/regenerate_consolidate_eway_bill_api_v_1_consolidatedEwayBillsRegenerate__post).

#### Sample Request

```json
{
    "userGstin": "XXXXXXXXXXXXXXX",
    "consolidated_eway_bill_number": 3210007391,
    "place_of_consignor": "Noida",
    "state_of_consignor": "Uttar Pradesh",
    "vehicle_number": "JJK8977",
    "mode_of_transport": 2,
    "transporter_document_number": 14456,
    "transporter_document_date": "15/09/2023",
    "reason_of_cancel": "Data Entry Mistake",
    "reason_for_updation": "Wrong Entry"
}
```

### Response Body

#### 200 (OK)

The response description for success can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/regenerate_consolidate_eway_bill_api_v_1_consolidatedEwayBillsRegenerate__post).

#### Sample Response

```json
{
  "results": {
    "message": {
      "tripSheetNo": 3910007392,
      "tripSheetEwayBills": [
        {
          "ewbNo": 381009218819
        },
        {
          "ewbNo": 371009218816
        }
      ],
      "error": false
    },
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "224: Invalid Transaction Date",
    "status": "No Content",
    "code": 204,
    "nic_code": "224"
  }
}
```


# Initiate Multi Vehicle

Initiate Multi Vehicle API

### Request Method

POST

### Request Path

```
{{API_URL}}/api/v1/multiVehicleMovement/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Body

The request body description for the API can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/initiate_multi_vehicle_api_v_1_multiVehicleMovement__post).

#### Sample Request

```json
{
    "userGstin": "XXXXXXXXXXXXXXX",
    "eway_bill_number": 321009218808,
    "reason_code_for_vehicle_updation": "due to break down",
    "reason_for_vehicle_updation": "",
    "place_of_consignor": "Dehradun",
    "state_of_consignor": "UTTARAKHAND",
    "place_of_consignee": "Beml Nagar",
    "state_of_consignee": "KARNATAKA",
    "mode_of_transport": 1,
    "total_quantity": 60,
    "unit_code": "NOS",
    "data_source": "erp"
}
```

### Response Body

#### 200 (OK)

The response description for success can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/initiate_multi_vehicle_api_v_1_multiVehicleMovement__post).

#### Sample Response

```json
{
  "results": {
    "message": {
      "ewbNo": "321009218808",
      "groupNo": "1",
      "createdDate": "15/09/2023 03:48:00 PM",
      "error": false
    },
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "220: Invalid Trans mode",
    "status": "No Content",
    "code": 204,
    "nic_code": "220"
  }
}
```


# Add Multi Vehicles

Add Multi Vehicles API

### Request Method

POST

### Request Path

```
{{API_URL}}/api/v1/addvehiclesDetailsforMultiVehicle/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Body

The request body description for the API can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/add_multi_vehicles_api_v_1_addvehiclesDetailsforMultiVehicle__post).

#### Sample Request

```json
{
    "userGstin": "XXXXXXXXXXXXXXX",
    "eway_bill_number": 321009218808,
    "group_number": "1",
    "vehicle_number": "HHJ9089",
    "transporter_document_number": "908899",
    "transporter_document_date": "25/06/2023",
    "quantity": 5.25,
    "data_source": "erp"
}
```

### Response Body

#### 200 (OK)

The response description for success can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/add_multi_vehicles_api_v_1_addvehiclesDetailsforMultiVehicle__post).

#### Sample Response

```json
{
  "results": {
    "message": {
      "ewbNo": "321009218808",
      "groupNo": "1",
      "vehAddedDate": "15/09/2023 03:50:00 PM",
      "error": false
    },
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "224: Invalid Transaction Date",
    "status": "No Content",
    "code": 204,
    "nic_code": "224"
  }
}
```


# Change Multi Vehicles

Add Multi Vehicles API

### Request Method

POST

### Request Path

```
{{API_URL}}/api/v1/changeVehiclesDetailsforMultiVehicle/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Body

The request body description for the API can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/change_multi_vehicles_api_v_1_changeVehiclesDetailsforMultiVehicle__post).

#### Sample Request

```json
{
    "userGstin": "XXXXXXXXXXXXXXX",
    "eway_bill_number": 321009218808,
    "group_number": 1,
    "old_vehicle_number": "HHJ9089",
    "new_vehicle_number": "UQC1234",
    "old_transporter_document_number": "908899",
    "new_transporter_document_number": "NEWTDN0011234",
    "place_of_consignor": "Dehradun",
    "state_of_consignor": "UTTARAKHAND",
    "reason_code_for_vehicle_updation": "due to break down",
    "reason_for_vehicle_updation": "",
    "data_source": "erp"
}
```

### Response Body

#### 200 (OK)

The response description for success can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/change_multi_vehicles_api_v_1_changeVehiclesDetailsforMultiVehicle__post).

#### Sample Response

```json
{
  "results": {
    "message": {
      "ewbNo": "321009218808",
      "groupNo": "1",
      "vehUpdDate": "15/09/2023 05:25:00 PM",
      "error": false
    },
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "406: Group number cannot be empty or zero.",
    "status": "No Content",
    "code": 204,
    "nic_code": "406"
  }
}
```


# Return Status (Blocked and Unblocked)

Blocked and Unblocked API

### Request Method

POST

### Request Path

```
{{API_URL}}/api/v1/returnStatus/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Body

The request body description for the API can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/return_status_api_v_1_returnStatus__post).

#### Sample Request

```json
{
    "user_gstin": "XXXXXXXXXXXXXXX",
    "GSTIN_Status":"N",
    "gstin_list": [
        {
            "gstin": "XXXXXXXXXXXXXXX"
        },
        {
            "gstin": "XXXXXXXXXXXXXXX"
        }
    ]
}
```

### Response Body

#### 200 (OK)

The response description for success can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/return_status_api_v_1_returnStatus__post).

#### Sample Response

```json
{
  "results": {
    "message": {
      "XXXXXXXXXXXXXXX": "Unblocked",
      "XXXXXXXXXXXXXXX": "Unblocked"
    },
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": {
      "XXXXXXXXXXXXXXX": "Incorrect user id/User does not exists",
      "XXXXXXXXXXXXXXX": "Incorrect user id/User does not exists"
    },
    "status": "Fail",
    "code": 204
  }
}
```


# Generate E-Way Bill In Bulk

Blocked and Unblocked API

### Request Method

POST

### Request Path

```
{{API_URL}}/api/v1/ewayBillsGenerateInBulk/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Body

The request body description for the API can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/generate_ewaybill_in_bulk_api_v_1_ewayBillsGenerateInBulk__post).

#### Sample Request

```json
{
    "ewayBillList": [
        {
            "userGstin": "XXXXXXXXXXXXXXX",
            "supply_type": "outward",
            "sub_supply_type": "Others",
            "sub_supply_description": "sales from other country",
            "document_type": "tax invoice",
            "document_number": "lkkkkk-1021",
            "document_date": "10/05/2018",
            "gstin_of_consignor": "XXXXXXXXXXXXXXX",
            "legal_name_of_consignor": "welton",
            "address1_of_consignor": "2ND CROSS NO 59 19 A",
            "address2_of_consignor": "GROUND FLOOR OSBORNE ROAD",
            "place_of_consignor": "Dehradun",
            "pincode_of_consignor": 248001,
            "state_of_consignor": "UTTARAKHAND",
            "actual_from_state_name": "UTTARAKHAND",
            "gstin_of_consignee": "XXXXXXXXXXXXXXX",
            "legal_name_of_consignee": "sthuthya",
            "address1_of_consignee": "Shree Nilaya",
            "address2_of_consignee": "Dasarahosahalli",
            "place_of_consignee": "Beml Nagar",
            "pincode_of_consignee": 248001,
            "state_of_supply": "UTTARAKHAND",
            "actual_to_state_name": "UTTARAKHAND",
            "total_invoice_value": 6002581.23,
            "taxable_amount": 5609889,
            "cgst_amount": 84148.335,
            "sgst_amount": 84148.335,
            "igst_amount": 0,
            "cess_amount": 224395.56,
            "transporter_id": "XXXXXXXXXXXXXXX",
            "transporter_name": "",
            "transporter_document_number": "",
            "transporter_document_date": "",
            "transportation_mode": "road",
            "transportation_distance": "100",
            "vehicle_number": "PVC1234",
            "vehicle_type": "Regular",
            "generate_status": 1,
            "data_source": "erp",
            "user_ref": "1232435466sdsf234",
            "location_code": "XYZ",
            "eway_bill_status": "ABC",
            "auto_print": "Y",
            "itemList": [
                {
                    "product_name": "Wheat",
                    "product_description": "Wheat",
                    "hsn_code": 1001,
                    "quantity": 4,
                    "unit_of_product": "BOX",
                    "cgst_rate": 1.5,
                    "sgst_rate": 1.5,
                    "igst_rate": 0,
                    "cess_rate": 0,
                    "cessAdvol": 0,
                    "taxable_amount": 5609889
                },
                {
                    "product_name": "Wheat",
                    "product_description": "Wheat",
                    "hsn_code": 1001,
                    "quantity": 4,
                    "unit_of_product": "BOX",
                    "cgst_rate": 1.5,
                    "sgst_rate": 1.5,
                    "igst_rate": 0,
                    "cess_rate": 0,
                    "cessAdvol": 0,
                    "taxable_amount": 5609889
                }
            ]
        },
        {
            "userGstin": "XXXXXXXXXXXXXXX",
            "supply_type": "outward",
            "sub_supply_type": "Others",
            "sub_supply_description": "sales from other country",
            "document_type": "tax invoice",
            "document_number": "lkkkkk-1033",
            "document_date": "10/05/2018",
            "gstin_of_consignor": "XXXXXXXXXXXXXXX",
            "legal_name_of_consignor": "welton",
            "address1_of_consignor": "2ND CROSS NO 59 19 A",
            "address2_of_consignor": "GROUND FLOOR OSBORNE ROAD",
            "place_of_consignor": "Dehradun",
            "pincode_of_consignor": 248001,
            "state_of_consignor": "UTTARAKHAND",
            "actual_from_state_name": "UTTARAKHAND",
            "gstin_of_consignee": "XXXXXXXXXXXXXXX",
            "legal_name_of_consignee": "sthuthya",
            "address1_of_consignee": "Shree Nilaya",
            "address2_of_consignee": "Dasarahosahalli",
            "place_of_consignee": "Beml Nagar",
            "pincode_of_consignee": 248001,
            "state_of_supply": "UTTARAKHAND",
            "actual_to_state_name": "UTTARAKHAND",
            "total_invoice_value": 6002581.23,
            "taxable_amount": 5609889,
            "cgst_amount": 84148.335,
            "sgst_amount": 84148.335,
            "igst_amount": 0,
            "cess_amount": 224395.56,
            "transporter_id": "",
            "transporter_name": "",
            "transporter_document_number": "",
            "transporter_document_date": "",
            "transportation_mode": "road",
            "transportation_distance": "100",
            "vehicle_number": "PVC1234",
            "vehicle_type": "Regular",
            "generate_status": 1,
            "data_source": "erp",
            "user_ref": "1232435466sdsf234",
            "location_code": "XYZ",
            "eway_bill_status": "ABC",
            "auto_print": "Y",
            "itemList": [
                {
                    "product_name": "Wheat",
                    "product_description": "Wheat",
                    "hsn_code": 1001,
                    "quantity": 4,
                    "unit_of_product": "BOX",
                    "cgst_rate": 1.5,
                    "sgst_rate": 1.5,
                    "igst_rate": 0,
                    "cess_rate": 0,
                    "cessAdvol": 0,
                    "taxable_amount": 5609889
                },
                {
                    "product_name": "Wheat",
                    "product_description": "Wheat",
                    "hsn_code": 1001,
                    "quantity": 4,
                    "unit_of_product": "BOX",
                    "cgst_rate": 1.5,
                    "sgst_rate": 1.5,
                    "igst_rate": 0,
                    "cess_rate": 0,
                    "cessAdvol": 0,
                    "taxable_amount": 5609889
                }
            ]
        }
    ]
}
```

### Response Body

#### 200 (OK)

The response description for success can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/generate_ewaybill_in_bulk_api_v_1_ewayBillsGenerateInBulk__post).

#### Sample Response

```json
{
  "results": {
    "status": "Success",
    "message": "Request has been accepted.Please get response by the request id",
    "code": 200,
    "request_status": "pending",
    "requestId": "edoc_1694792305_dc85e3f62632"
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "error": "invalid_request",
  "error_description": "Invalid Json Structure."
}
```


# Get E-Way Bill in Bulk

Get E-Way Bill in Bulk API

### Request Method

GET

### Request Path

```
{{API_URL}}/api/v1/getBulkEwayBillsResponse/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Params

| Parameter   | Value                          | Description                              |
| ----------- | ------------------------------ | ---------------------------------------- |
| request\_id | edoc\_1694792305\_dc85e3f62632 | Request id given in generate    bulk IRN |
|             |                                |                                          |

### Response Body

#### 200 (OK)

#### Sample Response

```json
{
  "results": [
    {
      "message": {
        "ewayBillNo": 331009218872,
        "ewayBillDate": "15/09/2023 09:05:00 PM",
        "validUpto": "16/09/2023 11:59:00 PM",
        "alert": "",
        "error": false,
        "url": "sandb-api.mastersindia.co/api/v1/detailPrintPdf/anVsX3NlcF8yMDIzLTI0-65047a724b0fa9b8fe92d11d/"
      },
      "status": "Success",
      "code": 200,
      "requestId": "ERP1694792306_lkkkkk-1021",
      "docNo": "lkkkkk-1021"
    },
    {
      "message": {
        "ewayBillNo": 301009218873,
        "ewayBillDate": "15/09/2023 09:05:00 PM",
        "validUpto": "16/09/2023 11:59:00 PM",
        "alert": "",
        "error": false,
        "url": "sandb-api.mastersindia.co/api/v1/detailPrintPdf/anVsX3NlcF8yMDIzLTI0-65047a734b0fa9b8fe92d11f/"
      },
      "status": "Success",
      "code": 200,
      "requestId": "ERP1694792307_lkkkkk-1033",
      "docNo": "lkkkkk-1033"
    }
  ]
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "status": "No Content",
    "code": 204,
    "request_status": "",
    "requestId": "edoc_1694792305_dc85e3f62631",
    "message": "No records found."
  }
}
```


# Generate E-Way Request in Bulk

Generate E-Way Request in Bulk API

### Request Method

POST

### Request Path

```
{{API_URL}}/api/v1/bulkEwayApiRequest/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Body

The request body description for the API can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/generate_ewaybill_request_in_bulk_api_v_1_bulkEwayApiRequest__post).

#### Sample Request

```json
{
    "action": "eway",
    "list": [
        {
            "userGstin": "XXXXXXXXXXXXXXX",
            "supply_type": "outward",
            "sub_supply_type": "Others",
            "sub_supply_description": "sales from other country",
            "document_type": "tax invoice",
            "document_number": "jjjkhh-1055",
            "document_date": "10/05/2018",
            "gstin_of_consignor": "XXXXXXXXXXXXXXX",
            "legal_name_of_consignor": "welton",
            "address1_of_consignor": "2ND CROSS NO 59 19 A",
            "address2_of_consignor": "GROUND FLOOR OSBORNE ROAD",
            "place_of_consignor": "Dehradun",
            "pincode_of_consignor": 248001,
            "state_of_consignor": "UTTARAKHAND",
            "actual_from_state_name": "UTTARAKHAND",
            "gstin_of_consignee": "XXXXXXXXXXXXXXX",
            "legal_name_of_consignee": "sthuthya",
            "address1_of_consignee": "Shree Nilaya",
            "address2_of_consignee": "Dasarahosahalli",
            "place_of_consignee": "Beml Nagar",
            "pincode_of_consignee": 248001,
            "state_of_supply": "UTTARAKHAND",
            "actual_to_state_name": "UTTARAKHAND",
            "total_invoice_value": 6002581.23,
            "taxable_amount": 5609889,
            "cgst_amount": 84148.335,
            "sgst_amount": 84148.335,
            "igst_amount": 0,
            "cess_amount": 224395.56,
            "transporter_id": "XXXXXXXXXXXXXXX",
            "transporter_name": "",
            "transporter_document_number": "",
            "transporter_document_date": "",
            "transportation_mode": "road",
            "transportation_distance": "100",
            "vehicle_number": "PVC1234",
            "vehicle_type": "Regular",
            "generate_status": 1,
            "data_source": "erp",
            "user_ref": "1232435466sdsf234",
            "location_code": "XYZ",
            "eway_bill_status": "ABC",
            "auto_print": "Y",
            "itemList": [
                {
                    "product_name": "Wheat",
                    "product_description": "Wheat",
                    "hsn_code": 1001,
                    "quantity": 4,
                    "unit_of_product": "BOX",
                    "cgst_rate": 1.5,
                    "sgst_rate": 1.5,
                    "igst_rate": 0,
                    "cess_rate": 0,
                    "cessAdvol": 0,
                    "taxable_amount": 5609889
                },
                {
                    "product_name": "Wheat",
                    "product_description": "Wheat",
                    "hsn_code": 1001,
                    "quantity": 4,
                    "unit_of_product": "BOX",
                    "cgst_rate": 1.5,
                    "sgst_rate": 1.5,
                    "igst_rate": 0,
                    "cess_rate": 0,
                    "cessAdvol": 0,
                    "taxable_amount": 5609889
                }
            ]
        },
        {
            "userGstin": "XXXXXXXXXXXXXXX",
            "supply_type": "outward",
            "sub_supply_type": "Others",
            "sub_supply_description": "sales from other country",
            "document_type": "tax invoice",
            "document_number": "abbbbdc-1066",
            "document_date": "10/05/2018",
            "gstin_of_consignor": "XXXXXXXXXXXXXXX",
            "legal_name_of_consignor": "welton",
            "address1_of_consignor": "2ND CROSS NO 59 19 A",
            "address2_of_consignor": "GROUND FLOOR OSBORNE ROAD",
            "place_of_consignor": "Dehradun",
            "pincode_of_consignor": 248001,
            "state_of_consignor": "UTTARAKHAND",
            "actual_from_state_name": "UTTARAKHAND",
            "gstin_of_consignee": "XXXXXXXXXXXXXXX",
            "legal_name_of_consignee": "sthuthya",
            "address1_of_consignee": "Shree Nilaya",
            "address2_of_consignee": "Dasarahosahalli",
            "place_of_consignee": "Beml Nagar",
            "pincode_of_consignee": 248001,
            "state_of_supply": "UTTARAKHAND",
            "actual_to_state_name": "UTTARAKHAND",
            "total_invoice_value": 6002581.23,
            "taxable_amount": 5609889,
            "cgst_amount": 84148.335,
            "sgst_amount": 84148.335,
            "igst_amount": 0,
            "cess_amount": 224395.56,
            "transporter_id": "",
            "transporter_name": "",
            "transporter_document_number": "",
            "transporter_document_date": "",
            "transportation_mode": "road",
            "transportation_distance": "100",
            "vehicle_number": "PVC1234",
            "vehicle_type": "Regular",
            "generate_status": 1,
            "data_source": "erp",
            "user_ref": "1232435466sdsf234",
            "location_code": "XYZ",
            "eway_bill_status": "ABC",
            "auto_print": "Y",
            "itemList": [
                {
                    "product_name": "Wheat",
                    "product_description": "Wheat",
                    "hsn_code": 1001,
                    "quantity": 4,
                    "unit_of_product": "BOX",
                    "cgst_rate": 1.5,
                    "sgst_rate": 1.5,
                    "igst_rate": 0,
                    "cess_rate": 0,
                    "cessAdvol": 0,
                    "taxable_amount": 5609889
                },
                {
                    "product_name": "Wheat",
                    "product_description": "Wheat",
                    "hsn_code": 1001,
                    "quantity": 4,
                    "unit_of_product": "BOX",
                    "cgst_rate": 1.5,
                    "sgst_rate": 1.5,
                    "igst_rate": 0,
                    "cess_rate": 0,
                    "cessAdvol": 0,
                    "taxable_amount": 5609889
                }
            ]
        }
    ]
}
```

### Response Body

#### 200 (OK)

The response description for success can be found [here](https://prepro-router.mastersindia.co/api/v1/redoc/#tag/Eway/operation/generate_ewaybill_request_in_bulk_api_v_1_bulkEwayApiRequest__post).

#### Sample Response

```json
{
  "results": {
    "status": "Success",
    "message": "Request has been accepted.Please get response by the request id",
    "code": 200,
    "request_status": "pending",
    "request_id": "edoc_1694792590_8200e8dcd6de"
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "status": "No Content",
    "message": "Invalid Action",
    "code": 204,
    "request_status": "Not Accepted",
    "request_id": ""
  }
}
```


# Get E-Way Response in Bulk

Get E-Way Response in Bulk API

### Request Method

GET

### Request Path

```
{{API_URL}}/api/v1/bulkEwayApiResponse/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Params

| Parameter   | Value                          | Description                              |
| ----------- | ------------------------------ | ---------------------------------------- |
| request\_id | edoc\_1694792305\_dc85e3f62632 | Request id given in generate    bulk IRN |
|             |                                |                                          |

### Response Body

#### 200 (OK)

#### Sample Response

```json
{
  "results": [
    {
      "message": {
        "ewayBillNo": 371009218874,
        "ewayBillDate": "15/09/2023 09:10:00 PM",
        "validUpto": "16/09/2023 11:59:00 PM",
        "alert": "",
        "error": false,
        "url": "sandb-api.mastersindia.co/api/v1/detailPrintPdf/anVsX3NlcF8yMDIzLTI0-65047b8f4b0fa9b8fe92d121/"
      },
      "status": "Success",
      "code": 200,
      "requestId": "ERP1694792591_jjjkhh-1055",
      "docNo": "jjjkhh-1055"
    },
    {
      "message": {
        "ewayBillNo": 341009218875,
        "ewayBillDate": "15/09/2023 09:10:00 PM",
        "validUpto": "16/09/2023 11:59:00 PM",
        "alert": "",
        "error": false,
        "url": "sandb-api.mastersindia.co/api/v1/detailPrintPdf/anVsX3NlcF8yMDIzLTI0-65047b8f4b0fa9b8fe92d123/"
      },
      "status": "Success",
      "code": 200,
      "requestId": "ERP1694792591_abbbbdc-1066",
      "docNo": "abbbbdc-1066"
    }
  ]
}

```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "status": "No Content",
    "code": 204,
    "request_status": "",
    "request_id": "edoc_1694792590_8200e8dcd6d",
    "message": "No records found."
  }
}
```


# Get E Way Bill Details

This method provides the e-way bill details for a given e-way bill number.

### Request Method

GET

### Request Path

```
{{API_URL}}/api/v1/getEwayBillData/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Params

| Parameter          | Value           | Description       |
| ------------------ | --------------- | ----------------- |
| action             | GetEwayBill     | Action            |
| gstin              | XXXXXXXXXXXXXXX | Gstin             |
| eway\_bill\_number | 321009218808    | E-Way Bill Number |

### Response Body

#### 200 (OK)

#### Sample Response

```json
{
  "results": {
    "message": {
      "eway_bill_number": 321009218808,
      "eway_bill_date": "15/09/2023 02:44:00 PM",
      "generate_mode": "API",
      "userGstin": "XXXXXXXXXXXXXXX",
      "supply_type": "OUTWARD",
      "sub_supply_type": "Supply",
      "document_type": "Tax Invoice",
      "document_number": "IMP/23/035",
      "document_date": "22/06/2023",
      "gstin_of_consignor": "XXXXXXXXXXXXXXX",
      "legal_name_of_consignor": "Welton",
      "address1_of_consignor": "The Taj Mahal Palace,Apollo Bandar",
      "address2_of_consignor": "Colaba,Mumbai",
      "place_of_consignor": "Mumbai",
      "pincode_of_consignor": 400001,
      "state_of_consignor": "UTTARAKHAND",
      "gstin_of_consignee": "XXXXXXXXXXXXXXX",
      "legal_name_of_consignee": "Sthuthya",
      "address1_of_consignee": "Shree Nilaya",
      "address2_of_consignee": "Dasarahosahalli",
      "place_of_consignee": "Dehradun",
      "pincode_of_consignee": 248001,
      "state_of_supply": "UTTARAKHAND",
      "taxable_amount": 500,
      "total_invoice_value": 560,
      "cgst_amount": 30,
      "sgst_amount": 30,
      "igst_amount": 0,
      "cess_amount": 0,
      "transporter_id": "XXXXXXXXXXXXXXX",
      "transporter_name": "M/S UTTARAYAN CO-OPERATIVE FOR RENEWABLE ENERGY",
      "eway_bill_status": "Active",
      "transportation_distance": 1769,
      "number_of_valid_days": 9,
      "eway_bill_valid_date": "24/09/2023 11:59:00 PM",
      "extended_times": 0,
      "reject_status": "N",
      "vehicle_type": "regular",
      "actual_from_state_name": "MAHARASHTRA",
      "actual_to_state_name": "UTTARAKHAND",
      "transaction_type": "Bill/Dispatch From",
      "other_value": 0,
      "cess_nonadvol_value": 0,
      "itemList": [
        {
          "item_number": 1,
          "product_id": 0,
          "product_name": "Wheat",
          "product_description": "Wheat",
          "hsn_code": 1001,
          "quantity": 5,
          "unit_of_product": "BOX",
          "cgst_rate": 6,
          "sgst_rate": 6,
          "igst_rate": 0,
          "cess_rate": 0,
          "cessNonAdvol": 0,
          "taxable_amount": 500
        }
      ],
      "VehiclListDetails": [
        {
          "update_mode": "API",
          "vehicle_number": "UQC1234",
          "place_of_consignor": "Dehradun",
          "state_of_consignor": "UTTARAKHAND",
          "tripshtNo": 0,
          "userGstin": "XXXXXXXXXXXXXXX",
          "vehicle_number_update_date": "15/09/2023 05:25:00 PM",
          "transportation_mode": "Road",
          "transporter_document_number": "NEWTDN0011234",
          "transporter_document_date": null,
          "group_number": "1"
        },
        {
          "update_mode": "API",
          "vehicle_number": "HHJ9089",
          "place_of_consignor": "Dehradun",
          "state_of_consignor": "UTTARAKHAND",
          "tripshtNo": 0,
          "userGstin": "XXXXXXXXXXXXXXX",
          "vehicle_number_update_date": "15/09/2023 03:50:00 PM",
          "transportation_mode": "Road",
          "transporter_document_number": "908899",
          "transporter_document_date": "25/06/2023",
          "group_number": "1"
        },
        {
          "update_mode": "API",
          "vehicle_number": "JJK8977",
          "place_of_consignor": "Noida",
          "state_of_consignor": "UTTAR PRADESH",
          "tripshtNo": 0,
          "userGstin": "XXXXXXXXXXXXXXX",
          "vehicle_number_update_date": "15/09/2023 02:46:00 PM",
          "transportation_mode": "Road",
          "transporter_document_number": "14456",
          "transporter_document_date": "25/06/2023",
          "group_number": "0"
        },
        {
          "update_mode": "API",
          "vehicle_number": "JJK8977",
          "place_of_consignor": "Noida",
          "state_of_consignor": "UTTAR PRADESH",
          "tripshtNo": 0,
          "userGstin": "XXXXXXXXXXXXXXX",
          "vehicle_number_update_date": "15/09/2023 02:45:00 PM",
          "transportation_mode": "Road",
          "transporter_document_number": "14456",
          "transporter_document_date": "25/06/2023",
          "group_number": "0"
        },
        {
          "update_mode": "API",
          "vehicle_number": "WXX2121",
          "place_of_consignor": "Mumbai",
          "state_of_consignor": "MAHARASHTRA",
          "tripshtNo": 0,
          "userGstin": "XXXXXXXXXXXXXXX",
          "vehicle_number_update_date": "15/09/2023 02:44:00 PM",
          "transportation_mode": "Road",
          "transporter_document_number": "",
          "transporter_document_date": null,
          "group_number": "0"
        }
      ]
    },
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "357: Could not retrieve eway bill details, pl. contact helpdesk",
    "status": "No Content",
    "code": 204,
    "nic_code": "357"
  }
}
```


# Get Other Party EWB

This method provides the list of E-way bills generated by other parties on your GSTIN. This can be used for rejecting the e-way bill, if required.

### Request Method

GET

### Request Path

```
{{API_URL}}/api/v1/getEwayBillData/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Params

| Parameter       | Value                    | Description    |
| --------------- | ------------------------ | -------------- |
| action          | GetEwayBillsofOtherParty | Action         |
| gstin           | XXXXXXXXXXXXXXX          | Gstin          |
| generated\_date | 15/09/2023               | Generated Date |

### Response Body

#### 200 (OK)

#### Sample Response

```json
{
  "results": {
    "message": [
      {
        "eway_bill_number": 301009218790,
        "eway_bill_date": "15/09/2023 01:55:00 PM",
        "generate_mode": "API",
        "userGstin": "XXXXXXXXXXXXXXX",
        "document_number": "eway/pctt11/2",
        "document_date": "10/05/2018",
        "gstin_of_consignor": "XXXXXXXXXXXXXXX",
        "legal_name_of_consignor": "welton",
        "gstin_of_consignee": "XXXXXXXXXXXXXXX",
        "legal_name_of_consignee": "sthuthya",
        "total_invoice_value": 16702.01,
        "hsn_code": 84314930,
        "hsn_description": "PIN/WB/H LINK 851",
        "eway_bill_status": "Active",
        "reject_status": "N"
      },
      {
        "eway_bill_number": 301009218857,
        "eway_bill_date": "15/09/2023 05:48:00 PM",
        "generate_mode": "API",
        "userGstin": "XXXXXXXXXXXXXXX",
        "document_number": "4239000005",
        "document_date": "15/09/2023",
        "gstin_of_consignor": "XXXXXXXXXXXXXXX",
        "legal_name_of_consignor": "Kasuya GPP Auto Products",
        "gstin_of_consignee": "XXXXXXXXXXXXXXX",
        "legal_name_of_consignee": "SHIVA TECHNIQUES SURFACES PVT. LTD.",
        "total_invoice_value": 0,
        "hsn_code": 84099990,
        "hsn_description": "LOMB. 2 CYL 107604508600  A/F OD GRIND F",
        "eway_bill_status": "Active",
        "reject_status": "N"
      },
      {
        "eway_bill_number": 311009218805,
        "eway_bill_date": "15/09/2023 02:39:00 PM",
        "generate_mode": "API",
        "userGstin": "XXXXXXXXXXXXXXX",
        "document_number": "eway/pctt11/4",
        "document_date": "10/05/2018",
        "gstin_of_consignor": "XXXXXXXXXXXXXXX",
        "legal_name_of_consignor": "welton",
        "gstin_of_consignee": "XXXXXXXXXXXXXXX",
        "legal_name_of_consignee": "sthuthya",
        "total_invoice_value": 16702.01,
        "hsn_code": 84314930,
        "hsn_description": "PIN/WB/H LINK 851",
        "eway_bill_status": "Active",
        "reject_status": "N"
      },
      {
        "eway_bill_number": 321009218770,
        "eway_bill_date": "15/09/2023 12:38:00 PM",
        "generate_mode": "API",
        "userGstin": "XXXXXXXXXXXXXXX",
        "document_number": "MIPL/169801032",
        "document_date": "02/11/2022",
        "gstin_of_consignor": "XXXXXXXXXXXXXXX",
        "legal_name_of_consignor": "welton",
        "gstin_of_consignee": "XXXXXXXXXXXXXXX",
        "legal_name_of_consignee": "sthuthya",
        "total_invoice_value": 118,
        "hsn_code": 1001,
        "hsn_description": "Wheat",
        "eway_bill_status": "Active",
        "reject_status": "N"
      },
      {
        "eway_bill_number": 331009218773,
        "eway_bill_date": "15/09/2023 12:46:00 PM",
        "generate_mode": "API",
        "userGstin": "XXXXXXXXXXXXXXX",
        "document_number": "MIPL/169801034",
        "document_date": "02/11/2022",
        "gstin_of_consignor": "XXXXXXXXXXXXXXX",
        "legal_name_of_consignor": "welton",
        "gstin_of_consignee": "XXXXXXXXXXXXXXX",
        "legal_name_of_consignee": "sthuthya",
        "total_invoice_value": 118,
        "hsn_code": 1001,
        "hsn_description": "Wheat",
        "eway_bill_status": "Active",
        "reject_status": "N"
      },
      {
        "eway_bill_number": 331009218814,
        "eway_bill_date": "15/09/2023 03:08:00 PM",
        "generate_mode": "API",
        "userGstin": "XXXXXXXXXXXXXXX",
        "document_number": "eway/pctt11/7",
        "document_date": "10/05/2018",
        "gstin_of_consignor": "XXXXXXXXXXXXXXX",
        "legal_name_of_consignor": "welton",
        "gstin_of_consignee": "XXXXXXXXXXXXXXX",
        "legal_name_of_consignee": "sthuthya",
        "total_invoice_value": 16702.01,
        "hsn_code": 84314930,
        "hsn_description": "PIN/WB/H LINK 851",
        "eway_bill_status": "Active",
        "reject_status": "N"
      }
    ],
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "366: You will not get the ewaybills generated today, howerver you cann access the ewaybills of yester days",
    "status": "No Content",
    "code": 204,
    "nic_code": "366"
  }
}
```


# Get Consolidated EWB

This method provides the Consolidated E-way bill details for a given E-way bill number.

### Request Method

GET

### Request Path

```
{{API_URL}}/api/v1/getEwayBillData/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Params

| Parameter                        | Value           | Description                    |
| -------------------------------- | --------------- | ------------------------------ |
| action                           | GetTripSheet    | Action                         |
| gstin                            | XXXXXXXXXXXXXXX | Gstin                          |
| consolidated\_eway\_bill\_number | 3210007391      | Consolidated e-way bill number |

### Response Body

#### 200 (OK)

#### Sample Response

```json
{
  "results": {
    "message": {
      "trip_sheet_number": 3210007391,
      "from_place": "rajpura",
      "state_of_consignor": "PUNJAB",
      "vehicle_number": "JJK8977",
      "transportation_mode": "Rail",
      "transporter_document_number": "14456",
      "transporter_document_date": "15/09/2023",
      "userGstin": "XXXXXXXXXXXXXXX",
      "entered_date": "15/09/2023 03:32:00 PM",
      "tripSheetEwbBills": [
        {
          "eway_bill_number": 381009218819,
          "eway_bill_date": "15/09/2023 03:18:00 PM",
          "userGstin": "XXXXXXXXXXXXXXX",
          "document_number": "eway/pctt11/8",
          "document_date": "10/05/2018",
          "gstin_of_consignor": "XXXXXXXXXXXXXXX",
          "legal_name_of_consignor": "welton",
          "gstin_of_consignee": "XXXXXXXXXXXXXXX",
          "legal_name_of_consignee": "sthuthya",
          "total_invoice_value": 16702,
          "eway_bill_valid_date": "16/09/2023 11:59:00 PM"
        },
        {
          "eway_bill_number": 371009218816,
          "eway_bill_date": "15/09/2023 03:10:00 PM",
          "userGstin": "XXXXXXXXXXXXXXX",
          "document_number": "T1ffr56t7931",
          "document_date": "04/05/2023",
          "gstin_of_consignor": "XXXXXXXXXXXXXXX",
          "legal_name_of_consignor": "LPG",
          "gstin_of_consignee": "XXXXXXXXXXXXXXX",
          "legal_name_of_consignee": "Is Pvt. Ltd.",
          "total_invoice_value": 119,
          "eway_bill_valid_date": "23/09/2023 11:59:00 PM"
        }
      ]
    },
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "325: Could not retrieve data",
    "status": "No Content",
    "code": 204,
    "nic_code": "325"
  }
}
```


# Get GSTIN Details

This method provides the tax payer and registered transporter’s details for a given GSTIN number.

### Request Method

GET

### Request Path

```
{{API_URL}}/api/v1/getEwayBillData/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Params

| Parameter | Value           | Description    |
| --------- | --------------- | -------------- |
| action    | GetGSTINDetails | Action         |
| userGstin | XXXXXXXXXXXXXXX | Gstin          |
| gstin     | XXXXXXXXXXXXXXX | Taxpayer gstin |

### Response Body

#### 200 (OK)

#### Sample Response

```json
{
  "results": {
    "message": {
      "gstin_of_taxpayer": "XXXXXXXXXXXXXXX",
      "trade_name": "M/S UTTARAYAN CO-OPERATIVE FOR RENEWABLE ENERGY",
      "legal_name_of_business": "UTTARAYAN CO-OPERATIVE FOR RENEWABLE ENERGY",
      "address1": "UCREPeelikothi , Near the nainital bank ltd,Kaladhungi Road",
      "address2": "263139Peelikothi",
      "state_name": "UTTARAKHAND",
      "pincode": "263139",
      "taxpayer_type": "REG",
      "status": "ACT",
      "block_status": ""
    },
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "325: Could not retrieve data",
    "status": "No Content",
    "code": 204,
    "nic_code": "325"
  }
}
```


# Get Transporter Details

This method provides the enrolled (unregistered) transporter details for a given Transporter Transin .

### Request Method

GET

### Request Path

```
{{API_URL}}/api/v1/getEwayBillData/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Params

| Parameter          | Value                 | Description      |
| ------------------ | --------------------- | ---------------- |
| action             | GetTransporterDetails | Action           |
| userGstin          | XXXXXXXXXXXXXXX       | Gstin            |
| transporter\_gstin | XXXXXXXXXXXXXXX       | Tansporter gstin |

### Response Body

#### 200 (OK)

#### Sample Response

```json
{
  "results": {
    "message": {
      "gstin_of_taxpayer": "XXXXXXXXXXXXXXX",
      "trade_name": "Jay Transport pvt",
      "legal_name_of_business": "Jay Transport pvt",
      "address1": "UCREPeelikothi , Near the nainital bank ltd,Kaladhungi Road",
      "address2": "263139Peelikothi",
      "state_name": "UTTARAKHAND",
      "pincode": "263139"
    },
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "325: Could not retrieve data",
    "status": "No Content",
    "code": 204,
    "nic_code": "325"
  }
}
```


# GET HSN Details

This method provides the HSN description details for a given HSN Code.

### Request Method

GET

### Request Path

```
{{API_URL}}/api/v1/getEwayBillData/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Params

| Parameter | Value                  | Description |
| --------- | ---------------------- | ----------- |
| action    | GetHsnDetailsByHsnCode | Action      |
| userGstin | XXXXXXXXXXXXXXX        | Gstin       |
| hsncode   | 1001                   | HSN Code    |

### Response Body

#### 200 (OK)

#### Sample Response

```json
{
  "results": {
    "message": {
      "hsn_code": "1001",
      "hsn_description": "WHEAT AND MESLIN - Durum wheat :"
    },
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "216: Invalid HSN Code",
    "status": "No Content",
    "code": 204,
    "nic_code": "216"
  }
}
```


# Get EWB By Consignor

This method provides the e-way bill details for a Document Type and Document number.

### Request Method

GET

### Request Path

```
{{API_URL}}/api/v1/getEwayBillData/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Params

| Parameter        | Value                           | Description     |
| ---------------- | ------------------------------- | --------------- |
| action           | GetEwayBillGeneratedByConsigner | Action          |
| gstin            | XXXXXXXXXXXXXXX                 | Gstin           |
| document\_number | IMP/23/035                      | Document Number |
| document\_type   | Tax Invoice                     | Document Type   |

### Response Body

#### 200 (OK)

#### Sample Response

```json
{
  "results": {
    "message": {
      "ewayBillNo": 321009218808,
      "ewayBillDate": "15/09/2023 02:44:00 PM",
      "validUpto": "24/09/2023 23:59:59 ",
      "alert": ""
    },
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "418: No record found.",
    "status": "No Content",
    "code": 204,
    "nic_code": "418"
  }
}
```


# Get EWB By Date

This method provides the list e-way bill details for a generated date.

### Request Method

GET

### Request Path

```
{{API_URL}}/api/v1/getEwayBillData/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Params

| Parameter       | Value              | Description    |
| --------------- | ------------------ | -------------- |
| action          | GetEwayBillsByDate | Action         |
| gstin           | XXXXXXXXXXXXXXX    | Gstin          |
| generated\_date | 15/09/2023         | Generated Date |

### Response Body

#### 200 (OK)

#### Sample Response

```json
{
  "results": {
    "message": [
      {
        "eway_bill_number": 321009218840,
        "eway_bill_date": "15/09/2023 04:21:00 PM",
        "eway_bill_status": "Active",
        "gstin_of_generator": "XXXXXXXXXXXXXXX",
        "document_number": "DC-505/23-24",
        "document_date": "15/09/2023",
        "pincode_of_delivery": 201301,
        "state_name_of_delivery": "UTTAR PRADESH",
        "place_of_delivery": "NOIDA",
        "eway_bill_valid_date": "16/09/2023 11:59:00 PM",
        "extended_times": 0,
        "reject_status": "N"
      },
      {
        "eway_bill_number": 321009218837,
        "eway_bill_date": "15/09/2023 04:13:00 PM",
        "eway_bill_status": "Active",
        "gstin_of_generator": "XXXXXXXXXXXXXXX",
        "document_number": "DC/GD-4/23-24",
        "document_date": "15/09/2023",
        "pincode_of_delivery": 201301,
        "state_name_of_delivery": "UTTAR PRADESH",
        "place_of_delivery": "NOIDA",
        "eway_bill_valid_date": "16/09/2023 11:59:00 PM",
        "extended_times": 0,
        "reject_status": "N"
      },
      {
        "eway_bill_number": 381009218835,
        "eway_bill_date": "15/09/2023 04:09:00 PM",
        "eway_bill_status": "Active",
        "gstin_of_generator": "XXXXXXXXXXXXXXX",
        "document_number": "FG-OT-9/23-24",
        "document_date": "15/09/2023",
        "pincode_of_delivery": 201301,
        "state_name_of_delivery": "UTTAR PRADESH",
        "place_of_delivery": "NOIDA",
        "eway_bill_valid_date": "16/09/2023 11:59:00 PM",
        "extended_times": 0,
        "reject_status": "N"
      },
      {
        "eway_bill_number": 311009218834,
        "eway_bill_date": "15/09/2023 04:07:00 PM",
        "eway_bill_status": "Active",
        "gstin_of_generator": "XXXXXXXXXXXXXXX",
        "document_number": "abc153",
        "document_date": "11/09/2023",
        "pincode_of_delivery": 201304,
        "state_name_of_delivery": "UTTAR PRADESH",
        "place_of_delivery": "Faridabad",
        "eway_bill_valid_date": "16/09/2023 11:59:00 PM",
        "extended_times": 0,
        "reject_status": "N"
      }
    ],
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "418: No record found.",
    "status": "No Content",
    "code": 204,
    "nic_code": "418"
  }
}
```


# Get EwayBills Rejected By Others

This method provides the list e-way bills rejected by other party by date.

### Request Method

GET

### Request Path

```
{{API_URL}}/api/v1/getEwayBillData/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Params

| Parameter       | Value                        | Description    |
| --------------- | ---------------------------- | -------------- |
| action          | GetEwayBillsRejectedByOthers | Action         |
| gstin           | XXXXXXXXXXXXXXX              | Gstin          |
| generated\_date | 15/09/2023                   | Generated Date |

### Response Body

#### 200 (OK)

#### Sample Response

```json
{
  "results": {
    "message": [
      {
        "eway_bill_number": 321009218808,
        "eway_bill_date": "15/09/2023 02:44:00 PM",
        "eway_bill_status": "Active",
        "gstin_of_generator": "XXXXXXXXXXXXXXX",
        "document_number": "IMP/23/035",
        "document_date": "22/06/2023",
        "eway_bill_valid_date": "24/09/2023 11:59:00 PM",
        "reject_status": "Y",
        "reject_date": "15/09/2023 08:05:00 PM",
        "pincode_of_delivery": "",
        "state_name_of_delivery": "",
        "extended_times": "",
        "place_of_delivery": ""
      },
      {
        "eway_bill_number": 321009218809,
        "eway_bill_date": "15/09/2023 02:44:00 PM",
        "eway_bill_status": "Active",
        "gstin_of_generator": "XXXXXXXXXXXXXXX",
        "document_number": "IMP/23/036",
        "document_date": "22/06/2023",
        "eway_bill_valid_date": "24/09/2023 11:59:00 PM",
        "reject_status": "Y",
        "reject_date": "15/09/2023 08:05:00 PM",
        "pincode_of_delivery": "",
        "state_name_of_delivery": "",
        "extended_times": "",
        "place_of_delivery": ""
      }
    ],
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "418: No record found.",
    "status": "No Content",
    "code": 204,
    "nic_code": "418"
  }
}
```


# Get EWB By Transporter 1

This method provides the list of E-way bills assigned to requesting GSTIN/TRANSIN for transportation based on generated date and state code of the generator of the E-waybill.

### Request Method

GET

### Request Path

```
{{API_URL}}/api/v1/getEwayBillData/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Params

| Parameter       | Value                             | Description    |
| --------------- | --------------------------------- | -------------- |
| action          | GetEwayBillsForTransporterByState | Action         |
| gstin           | XXXXXXXXXXXXXXX                   | Gstin          |
| generated\_date | 25/06/2023                        | Generated Date |
| state\_code     | 5                                 | State Code     |

### Response Body

#### 200 (OK)

#### Sample Response

```json
{
  "results": {
    "message": [
      {
        "eway_bill_number": 321009218770,
        "eway_bill_date": "15/09/2023 12:38:00 PM",
        "eway_bill_status": "Active",
        "gstin_of_generator": "XXXXXXXXXXXXXXX",
        "document_number": "MIPL/169801032",
        "document_date": "02/11/2022",
        "pincode_of_delivery": 247663,
        "state_name_of_delivery": "UTTARAKHAND",
        "place_of_delivery": "Beml Nagar",
        "eway_bill_valid_date": "16/09/2023 11:59:00 PM",
        "extended_times": 0,
        "reject_status": "N"
      },
      {
        "eway_bill_number": 361009218772,
        "eway_bill_date": "15/09/2023 12:45:00 PM",
        "eway_bill_status": "Active",
        "gstin_of_generator": "XXXXXXXXXXXXXXX",
        "document_number": "MIPL/169801033",
        "document_date": "02/11/2022",
        "pincode_of_delivery": 247663,
        "state_name_of_delivery": "UTTARAKHAND",
        "place_of_delivery": "Beml Nagar",
        "eway_bill_valid_date": "16/09/2023 11:59:00 PM",
        "extended_times": 0,
        "reject_status": "N"
      },
      {
        "eway_bill_number": 331009218773,
        "eway_bill_date": "15/09/2023 12:46:00 PM",
        "eway_bill_status": "Active",
        "gstin_of_generator": "XXXXXXXXXXXXXXX",
        "document_number": "MIPL/169801034",
        "document_date": "02/11/2022",
        "pincode_of_delivery": 247663,
        "state_name_of_delivery": "UTTARAKHAND",
        "place_of_delivery": "Beml Nagar",
        "eway_bill_valid_date": "16/09/2023 11:59:00 PM",
        "extended_times": 0,
        "reject_status": "N"
      },
      {
        "eway_bill_number": 371009218775,
        "eway_bill_date": "15/09/2023 01:02:00 PM",
        "eway_bill_status": "Active",
        "gstin_of_generator": "XXXXXXXXXXXXXXX",
        "document_number": "767676",
        "document_date": "09/01/2022",
        "pincode_of_delivery": 201301,
        "state_name_of_delivery": "UTTAR PRADESH",
        "place_of_delivery": "VARANASI",
        "eway_bill_valid_date": "16/09/2023 11:59:00 PM",
        "extended_times": 0,
        "reject_status": "N"
      },
      {
        "eway_bill_number": 351009218782,
        "eway_bill_date": "15/09/2023 01:26:00 PM",
        "eway_bill_status": "Active",
        "gstin_of_generator": "XXXXXXXXXXXXXXX",
        "document_number": "FG-OT-6/23-24",
        "document_date": "15/09/2023",
        "pincode_of_delivery": 201301,
        "state_name_of_delivery": "UTTAR PRADESH",
        "place_of_delivery": "NOIDA",
        "eway_bill_valid_date": "16/09/2023 11:59:00 PM",
        "extended_times": 0,
        "reject_status": "N"
      }
    ],
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "336: Could not retrieve transporter data by gstin",
    "status": "No Content",
    "code": 204,
    "nic_code": "336"
  }
}
```


# Get EWB By Transporter 2

This method provides the list of eway bills assigned to requesting GSTIN/TRANSIN for a transportation of goods by his clients in his state, based on generated date.

### Request Method

GET

### Request Path

```
{{API_URL}}/api/v1/getEwayBillData/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Params

| Parameter       | Value                      | Description    |
| --------------- | -------------------------- | -------------- |
| action          | GetEwayBillsForTransporter | Action         |
| gstin           | XXXXXXXXXXXXXXX            | Gstin          |
| generated\_date | 25/06/2023                 | Generated Date |

### Response Body

#### 200 (OK)

#### Sample Response

```json
{
  "results": {
    "message": [
      {
        "eway_bill_number": 321009218770,
        "eway_bill_date": "15/09/2023 12:38:00 PM",
        "eway_bill_status": "Active",
        "gstin_of_generator": "XXXXXXXXXXXXXXX",
        "document_number": "MIPL/169801032",
        "document_date": "02/11/2022",
        "pincode_of_delivery": 247663,
        "state_name_of_delivery": "UTTARAKHAND",
        "place_of_delivery": "Beml Nagar",
        "eway_bill_valid_date": "16/09/2023 11:59:00 PM",
        "extended_times": 0,
        "reject_status": "N"
      },
      {
        "eway_bill_number": 361009218772,
        "eway_bill_date": "15/09/2023 12:45:00 PM",
        "eway_bill_status": "Active",
        "gstin_of_generator": "XXXXXXXXXXXXXXX",
        "document_number": "MIPL/169801033",
        "document_date": "02/11/2022",
        "pincode_of_delivery": 247663,
        "state_name_of_delivery": "UTTARAKHAND",
        "place_of_delivery": "Beml Nagar",
        "eway_bill_valid_date": "16/09/2023 11:59:00 PM",
        "extended_times": 0,
        "reject_status": "N"
      }
    ],
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "336: Could not retrieve transporter data by gstin",
    "status": "No Content",
    "code": 204,
    "nic_code": "336"
  }
}
```


# Get EWB By Transporter 3

This method provides the list of E-way bills assigned to requesting GSTIN/TRANSIN for transportation by a given GSTIN, based on generated date.

### Request Method

GET

### Request Path

```
{{API_URL}}/api/v1/getEwayBillData/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Params

| Parameter                    | Value                             | Description                   |
| ---------------------------- | --------------------------------- | ----------------------------- |
| action                       | GetEwayBillsForTransporterByGstin | Action                        |
| gstin                        | XXXXXXXXXXXXXXX                   | Gstin                         |
| eway\_bill\_generator\_gstin | XXXXXXXXXXXXXXX                   | Generator gstin of E-Way Bill |
| generated\_date              | 25/06/2023                        | Generated Date                |

### Response Body

#### 200 (OK)

#### Sample Response

```json
{
  "results": {
    "message": [
      {
        "eway_bill_number": 321009218808,
        "eway_bill_date": "15/09/2023 02:44:00 PM",
        "eway_bill_status": "Active",
        "gstin_of_generator": "XXXXXXXXXXXXXXX",
        "document_number": "IMP/23/035",
        "document_date": "22/06/2023",
        "pincode_of_delivery": 248001,
        "state_name_of_delivery": "UTTARAKHAND",
        "place_of_delivery": "Dehradun",
        "eway_bill_valid_date": "24/09/2023 11:59:00 PM",
        "extended_times": 0,
        "reject_status": "Y"
      }
    ],
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "336: Could not retrieve transporter data by gstin",
    "status": "No Content",
    "code": 204,
    "nic_code": "336"
  }
}
```


# Get EWB By Transporter 4

This method provides the list of E-way bills assigned to GSTIN/TRANSIN for transportation based on date of assignment of the E-waybill and state code

### Request Method

GET

### Request Path

```
{{API_URL}}/api/v1/getEwayBillData/
```

### Request Headers

| Parameter              | Value               | Description                                                   |
| ---------------------- | ------------------- | ------------------------------------------------------------- |
| Authorization/api\_key | api\_key/auth token | Value and header type is mentioned in the Authentication Page |

### Request Params

| Parameter      | Value                                      | Description   |
| -------------- | ------------------------------------------ | ------------- |
| action         | GetEwayBillReportByTransporterassignedDate | Action        |
| gstin          | XXXXXXXXXXXXXXX                            | Gstin         |
| assigned\_date | 25/06/2023                                 | Assigned Date |
| state\_code    | 5                                          | State Code    |

### Response Body

#### 200 (OK)

#### Sample Response

```json
{
  "results": {
    "message": [
      {
        "eway_bill_number": 321009218808,
        "eway_bill_date": "15/09/2023 02:44:00 PM",
        "eway_bill_status": "Active",
        "gstin_of_generator": "XXXXXXXXXXXXXXX",
        "document_number": "IMP/23/035",
        "document_date": "22/06/2023",
        "pincode_of_delivery": 248001,
        "state_name_of_delivery": "UTTARAKHAND",
        "place_of_delivery": "Dehradun",
        "eway_bill_valid_date": "24/09/2023 11:59:00 PM",
        "extended_times": 0,
        "reject_status": "Y"
      },
      {
        "eway_bill_number": 341009218804,
        "eway_bill_date": "15/09/2023 02:38:00 PM",
        "eway_bill_status": "Active",
        "gstin_of_generator": "XXXXXXXXXXXXXXX",
        "document_number": "eway/pctt11/3",
        "document_date": "10/05/2018",
        "pincode_of_delivery": 121004,
        "state_name_of_delivery": "HARYANA",
        "place_of_delivery": "Beml Nagar",
        "eway_bill_valid_date": "",
        "extended_times": 0,
        "reject_status": "N"
      }
    ],
    "status": "Success",
    "code": 200
  }
}
```

#### 204 (Invalid Parameters)

```json
{
  "results": {
    "message": "336: Could not retrieve transporter data by gstin",
    "status": "No Content",
    "code": 204,
    "nic_code": "336"
  }
}
```


