E-Invoice/E-WayBill APIs

API – Get E-Waybill Generated By Consigner

This API is used to get details of e-waybill generated by consigner for a given document.

URL

GET https://app.octagst.com/api/einvoice/getewaybillgeneratedbyconsigner?gstin={value}&doctype={value}&docno={value}

Query Parameters

NameDescriptionTypeValue
gstinIt specifies GSTIN of requesterMandatory
doctypeIt specifies document typeMandatory
INV: Invoice
BIL: Bill of Supply
BOE: Bill of Entry
CHL: Delivery Challan
OTH: Others
docnoIt specifies document numberMandatory

Success Response

Response payload will contains the success status along with e-Waybill information.

{
  "Success": true,
  "EwbStatus": "ACT",
  "EwbNo": "191008688443",
  "EwbTime": "27/11/2020 17:23:45",
  "EwbValidTill": "29/11/2020 17:23:45"
}

Failure Response

If API request fails for some reason, response payload will contain the failure status and a list of errors.

{
  "Success": false,
  "Errors": [
    {
      "Code": "ERR_CODE_1",
      "Message": "ERR MESSAGE 1"
    },
    {
      "Code": "ERR_CODE_n",
      "Message": "ERR MESSAGE n"
    }
  ]
}