Get E-Way Bill

Get E-Way Bill

curl --request GET \
  --url https://api.sandbox.co.in/gst/compliance/e-way-bill/tax-payer/bill/{ewb_no} \
  --header 'Authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>'

{
  "code": 200,
  "data": {
    "data": {
      "VehiclListDetails": [
        {
          "enteredDate": "01/05/2024 07:00:00 PM",
          "fromPlace": "FRAZER TOWN",
          "fromState": 27,
          "groupNo": "0",
          "transDocDate": null,
          "transDocNo": "",
          "transMode": "1",
          "tripshtNo": 0,
          "updMode": "API",
          "userGSTINTransin": "27AAACQ3770E004",
          "vehicleNo": "PVC1234"
        }
      ],
      "actFromStateCode": 27,
      "actToStateCode": 29,
      "actualDist": 1000,
      "cessNonAdvolValue": 400,
      "cessValue": 400.56,
      "cgstValue": 0,
      "docDate": "15/12/2017",
      "docNo": "7001-8",
      "docType": "INV",
      "ewayBillDate": "01/05/2024 07:00:00 PM",
      "ewbNo": 291010077005,
      "extendedTimes": 0,
      "fromAddr1": "2ND CROSS NO 59  19  A",
      "fromAddr2": "GROUND FLOOR OSBORNE ROAD",
      "fromGstin": "29AAACQ3770E000",
      "fromPincode": 400027,
      "fromPlace": "FRAZER TOWN",
      "fromStateCode": 27,
      "fromTrdName": "welton",
      "genMode": "API",
      "igstValue": 300.67,
      "itemList": [
        {
          "cessNonAdvol": 0,
          "cessRate": 3,
          "cgstRate": 0,
          "hsnCode": 1001,
          "igstRate": 3,
          "itemNo": 1,
          "productDesc": "Wheat",
          "productId": 0,
          "productName": "Wheat",
          "qtyUnit": "BOX",
          "quantity": 4,
          "sgstRate": 0,
          "taxableAmount": 5609889
        }
      ],
      "noValidDays": 5,
      "otherValue": -100,
      "rejectStatus": "N",
      "sgstValue": 0,
      "status": "ACT",
      "subSupplyType": "1  ",
      "supplyType": "O",
      "toAddr1": "Shree Nilaya",
      "toAddr2": "Dasarahosahalli",
      "toGstin": "27AAACQ3770E000",
      "toPincode": 560090,
      "toPlace": "Beml Nagar",
      "toStateCode": 29,
      "toTrdName": "sthuthya",
      "totInvValue": 68358,
      "totalValue": 56099,
      "transactionType": 4,
      "transporterId": "27AAACQ3770E004",
      "transporterName": "Acme Industries Private Limited",
      "userGstin": "29AAACQ3770E000",
      "validUpto": "06/05/2024 11:59:00 PM",
      "vehicleType": "R"
    },
    "status": "1"
  },
  "timestamp": 1763446641000,
  "transaction_id": "6dddbe8f-147f-4678-88b6-003f112854d7"
}

GET

gst

compliance

e-way-bill

tax-payer

bill

{ewb_no}

Get E-Way Bill

curl --request GET \
  --url https://api.sandbox.co.in/gst/compliance/e-way-bill/tax-payer/bill/{ewb_no} \
  --header 'Authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>'

{
  "code": 200,
  "data": {
    "data": {
      "VehiclListDetails": [
        {
          "enteredDate": "01/05/2024 07:00:00 PM",
          "fromPlace": "FRAZER TOWN",
          "fromState": 27,
          "groupNo": "0",
          "transDocDate": null,
          "transDocNo": "",
          "transMode": "1",
          "tripshtNo": 0,
          "updMode": "API",
          "userGSTINTransin": "27AAACQ3770E004",
          "vehicleNo": "PVC1234"
        }
      ],
      "actFromStateCode": 27,
      "actToStateCode": 29,
      "actualDist": 1000,
      "cessNonAdvolValue": 400,
      "cessValue": 400.56,
      "cgstValue": 0,
      "docDate": "15/12/2017",
      "docNo": "7001-8",
      "docType": "INV",
      "ewayBillDate": "01/05/2024 07:00:00 PM",
      "ewbNo": 291010077005,
      "extendedTimes": 0,
      "fromAddr1": "2ND CROSS NO 59  19  A",
      "fromAddr2": "GROUND FLOOR OSBORNE ROAD",
      "fromGstin": "29AAACQ3770E000",
      "fromPincode": 400027,
      "fromPlace": "FRAZER TOWN",
      "fromStateCode": 27,
      "fromTrdName": "welton",
      "genMode": "API",
      "igstValue": 300.67,
      "itemList": [
        {
          "cessNonAdvol": 0,
          "cessRate": 3,
          "cgstRate": 0,
          "hsnCode": 1001,
          "igstRate": 3,
          "itemNo": 1,
          "productDesc": "Wheat",
          "productId": 0,
          "productName": "Wheat",
          "qtyUnit": "BOX",
          "quantity": 4,
          "sgstRate": 0,
          "taxableAmount": 5609889
        }
      ],
      "noValidDays": 5,
      "otherValue": -100,
      "rejectStatus": "N",
      "sgstValue": 0,
      "status": "ACT",
      "subSupplyType": "1  ",
      "supplyType": "O",
      "toAddr1": "Shree Nilaya",
      "toAddr2": "Dasarahosahalli",
      "toGstin": "27AAACQ3770E000",
      "toPincode": 560090,
      "toPlace": "Beml Nagar",
      "toStateCode": 29,
      "toTrdName": "sthuthya",
      "totInvValue": 68358,
      "totalValue": 56099,
      "transactionType": 4,
      "transporterId": "27AAACQ3770E004",
      "transporterName": "Acme Industries Private Limited",
      "userGstin": "29AAACQ3770E000",
      "validUpto": "06/05/2024 11:59:00 PM",
      "vehicleType": "R"
    },
    "status": "1"
  },
  "timestamp": 1763446641000,
  "transaction_id": "6dddbe8f-147f-4678-88b6-003f112854d7"
}

Headers

Authorization

string

required

E-Way Bill access token

x-source

string

Example:

"primary"

x-proxy

string

Example:

"secondary"

x-api-key

string

required

API key for identification

x-api-version

string

default:1.0.0

API version

Path Parameters

ewb_no

string

required

Example:

"141011175250"

Response

200 - application/json

200 EWB fetched / 357 EWB data not available / 200 Fetch rejected EWB

code

number

Example:

200

data

object

Show child attributes

data.data

object

Show child attributes

data.data.VehiclListDetails

object[]

Show child attributes

data.data.VehiclListDetails.enteredDate

string

Example:

"01/05/2024 07:00:00 PM"

data.data.VehiclListDetails.fromPlace

string

Example:

"FRAZER TOWN"

data.data.VehiclListDetails.fromState

number

Example:

27

data.data.VehiclListDetails.groupNo

string

Example:

"0"

data.data.VehiclListDetails.transDocDate

unknown

data.data.VehiclListDetails.transDocNo

string

Example:

""

data.data.VehiclListDetails.transMode

string

Example:

"1"

data.data.VehiclListDetails.tripshtNo

number

Example:

0

data.data.VehiclListDetails.updMode

string

Example:

"API"

data.data.VehiclListDetails.userGSTINTransin

string

Example:

"27AAACQ3770E004"

data.data.VehiclListDetails.vehicleNo

string

Example:

"PVC1234"

Example:

[
  {
    "enteredDate": "01/05/2024 07:00:00 PM",
    "fromPlace": "FRAZER TOWN",
    "fromState": 27,
    "groupNo": "0",
    "transDocDate": null,
    "transDocNo": "",
    "transMode": "1",
    "tripshtNo": 0,
    "updMode": "API",
    "userGSTINTransin": "27AAACQ3770E004",
    "vehicleNo": "PVC1234"
  }
]

data.data.actFromStateCode

number

Example:

27

data.data.actToStateCode

number

Example:

29

data.data.actualDist

number

Example:

1000

data.data.cessNonAdvolValue

number

Example:

400

data.data.cessValue

number

Example:

400.56

data.data.cgstValue

number

Example:

0

data.data.docDate

string

Example:

"15/12/2017"

data.data.docNo

string

Example:

"7001-8"

data.data.docType

string

Example:

"INV"

data.data.ewayBillDate

string

Example:

"01/05/2024 07:00:00 PM"

data.data.ewbNo

number

Example:

291010077005

data.data.extendedTimes

number

Example:

0

data.data.fromAddr1

string

Example:

"2ND CROSS NO 59 19 A"

data.data.fromAddr2

string

Example:

"GROUND FLOOR OSBORNE ROAD"

data.data.fromGstin

string

Example:

"29AAACQ3770E000"

data.data.fromPincode

number

Example:

400027

data.data.fromPlace

string

Example:

"FRAZER TOWN"

data.data.fromStateCode

number

Example:

27

data.data.fromTrdName

string

Example:

"welton"

data.data.genMode

string

Example:

"API"

data.data.igstValue

number

Example:

300.67

data.data.itemList

object[]

Show child attributes

data.data.itemList.cessNonAdvol

number

Example:

0

data.data.itemList.cessRate

number

Example:

3

data.data.itemList.cgstRate

number

Example:

0

data.data.itemList.hsnCode

number

Example:

1001

data.data.itemList.igstRate

number

Example:

3

data.data.itemList.itemNo

number

Example:

1

data.data.itemList.productDesc

string

Example:

"Wheat"

data.data.itemList.productId

number

Example:

0

data.data.itemList.productName

string

Example:

"Wheat"

data.data.itemList.qtyUnit

string

Example:

"BOX"

data.data.itemList.quantity

number

Example:

4

data.data.itemList.sgstRate

number

Example:

0

data.data.itemList.taxableAmount

number

Example:

5609889

Example:

[
  {
    "cessNonAdvol": 0,
    "cessRate": 3,
    "cgstRate": 0,
    "hsnCode": 1001,
    "igstRate": 3,
    "itemNo": 1,
    "productDesc": "Wheat",
    "productId": 0,
    "productName": "Wheat",
    "qtyUnit": "BOX",
    "quantity": 4,
    "sgstRate": 0,
    "taxableAmount": 5609889
  }
]

data.data.noValidDays

number

Example:

5

data.data.otherValue

number

Example:

-100

data.data.rejectStatus

string

Example:

"N"

data.data.sgstValue

number

Example:

0

data.data.status

string

Example:

"ACT"

data.data.subSupplyType

string

Example:

"1 "

data.data.supplyType

string

Example:

"O"

data.data.toAddr1

string

Example:

"Shree Nilaya"

data.data.toAddr2

string

Example:

"Dasarahosahalli"

data.data.toGstin

string

Example:

"27AAACQ3770E000"

data.data.toPincode

number

Example:

560090

data.data.toPlace

string

Example:

"Beml Nagar"

data.data.toStateCode

number

Example:

29

data.data.toTrdName

string

Example:

"sthuthya"

data.data.totInvValue

number

Example:

68358

data.data.totalValue

number

Example:

56099

data.data.transactionType

number

Example:

4

data.data.transporterId

string

Example:

"27AAACQ3770E004"

data.data.transporterName

string

Example:

"Acme Industries Private Limited"

data.data.userGstin

string

Example:

"29AAACQ3770E000"

data.data.validUpto

string

Example:

"06/05/2024 11:59:00 PM"

data.data.vehicleType

string

Example:

"R"

data.error

object

Show child attributes

data.error.errorCodes

string

Example:

"357"

data.info

string

Example:

""

data.status

string

Example:

"1"

timestamp

number

Example:

1763446641000

transaction_id

string

Example:

"6dddbe8f-147f-4678-88b6-003f112854d7"

Update Vehicle

Get Error List

⌘I

Analytics

Compliance

Headers

Path Parameters

Response