Skip to content

Verify Invoice With Eway Bill#

Verify Invoice With Eway Bill API supports verification of existence of the EwayBill and Invoice data for which the Eway Bill is generated.Data fields that can be verified are ewbNumber, docType, docNo, docDate, fromGstin, toGstin, totInvValue, cessNonAdvolValue.These fields are validated based on the values provided along with Eway Bill generation.

This verification is optional and will be triggered only if the respective field value is provided in request payload.

Verify Invoice With Eway Bill is an asynchronous API, hence will give a task ID in response.
Given a task ID, fetch the task status using Status API. In order to download the result, you would need to use Download API.

Note

  • Duplicate Eway Bill numbers will not be allowed in same API call.
  • More than 50 Eway Bill number will not be allowed in same API call.

API Route#

Route

/enriched/eway/{flynn-version}/{ewb_provider}/eway-bills/verify-ewb

  • active ‘flynn-version’ : v3.0
  • method: POST

URL Parameters#

Name Description Type
flynn-version version of the API, for example (v3.0) string
ewb_provider Eway bill provider
for example, ew1		 enum(ew1, ew2)

Headers#

All headers as mentioned in the Trade Verification Invoice and EWB APIs introduction.

Tip

The only valid values for the header keys Content-Type and accept must have to be application/json.

Request#

Body consists of two sections, “payload” and “meta”.
payload contains Invoice and E-way Bill information in a list for Verification.
meta section of the request body consists of meta information for call i.e,
  • Tolerance :   While validating amount fields this value will be considered. This will be the allowable amount of variation (±), in Rupees, during comparison. This is an optional input and default value is 0.
  • ToleranceInPercentage :   If this flag is set true then while validating amount fields tolerance value mentioned above will be considered as percentage. This is an optional input and the default value is false.
  • PDF :   If this flag set to true and if verification is successful, the Eway Bill PDF will be generated and added to response. This is optional input and the default value is false.
  • JSON :   If this flag set to true and if verification is successful, the Eway Bill Json will be added to response. This is an optional input and the default value is false.

Sample Request Body

{
  "payload": [
    {
      "ewbNumber": "141002176530",
      "docType": "INV",
      "docNo": "1674455553249VZY",
      "docDate": "23/01/2022",
      "fromGstin": "29AAACW4202F1ZM",
      "toGstin": "29AEKPV7203E1Z9",
      "totInvValue": 11556371.34,
      "totalValue": 5609889.0,
      "cgstValue": 336593.34,
      "sgstValue": 336593.34,
      "igstValue": 0.0,
      "cessValue": 0.0,
      "otherValue": -1.0,
      "cessNonAdvolValue": 1.0
    }
  ],
  "meta": {
    "pdf": "N",
    "json": "Y",
    "tolerance": 2,
    "isToleranceInPercentage": "N"
  }
}

Only ewbNumber is the mandatory field in request json, other fields are optional.

Response#

200:#

Successful response will have an async task-id. Using this task-id you will be able to fetch the status of the request.

Sample Response Body

{
  "status": "1",
  "data": {
  "task-id": "d139aedf-395a-4b6d-a76c-bb2c9bf83098"
  },
  "error": null,
  "info": null,
  "additionalInfo": null,
  "alert": null
}
Download API Response:#

Download API response is unique for each API.
Content of result.json file in case in meta json and pdf is true and verification is successful.

Example

{
  "status": "1",
  "data": [
    {
      "status": "1",
      "data": {
        "details": null,
        "json": "141002176530.json",
        "pdf": "141002176530.pdf"
      },
      "error": null,
      "info": null,
      "additionalInfo": {
        "key": {
          "ewb-number": "141002176530"
        }
      },
      "alert": null
    }
  ],
  "error": null,
  "info": null,
  "additionalInfo": null,
  "alert": null
}

Contents of result.json file in case in meta json and pdf is false and verification is successful

Example

{
  "status": "1",
  "data": [
    {
      "status": "1",
      "data": {
        "details": null,
        "json": null,
        "pdf": null
      },
      "error": null,
      "info": null,
      "additionalInfo": {
        "key": {
          "ewb-number": "141002176530"
        }
      },
      "alert": null
    }
  ],
  "error": null,
  "info": null,
  "additionalInfo": null,
  "alert": null
}

Contents of result.json file in case of field verification failed

Example

{
    "status": "1",
    "data": [
        {
            "status": "0",
            "data": null,
            "error": [
                {
                    "type": "client-request",
                    "message": "err-ewb-verification-failed",
                    "args": {
                        "invalid docNo": "1674455553249VY",
                        "invalid docDate": "02/01/2023"
                    }
                }
            ],
            "info": null,
            "additionalInfo": {
              "key": {
                "ewb-number": "141002176530"
                }
              },
            "alert": null
        }
    ],
    "error": null,
    "info": null,
    "additionalInfo": null,
    "alert": null
}

Contents of ewb.json file in case json is true

Sample ewb.json File

  {
    "actFromStateCode": 29,
    "actToStateCode": 29,
    "actualDist": 7,
    "cessValue": 0.0,
    "cgstValue": 336593.34,
    "docDate": 1674432000000,
    "docNo": "1674455553249VZY",
    "docType": "INV",
    "ewayBillDate": "23/01/2023 12:02:00 PM",
    "ewbNo": 141002176530,
    "extendedTimes": 0,
    "fromAddr1": "2ND CROSS NO 59  19  A",
    "fromAddr2": "GROUND FLOOR OSBORNE ROAD",
    "fromGstin": "29AAACW4202F1ZM",
    "fromPincode": 577217,
    "fromPlace": "FRAZER TOWN",
    "fromStateCode": 29,
    "fromTrdName": "welton",
    "genMode": "API",
    "igstValue": 0.0,
    "noValidDays": 1,
    "rejectStatus": "N",
    "vehicleType": "R",
    "sgstValue": 336593.34,
    "status": "ACT",
    "subSupplyType": "1",
    "supplyType": "O",
    "toAddr1": "Shree Nilaya",
    "toAddr2": "Dasarahosahalli",
    "toGstin": "29AEKPV7203E1Z9",
    "toPincode": 560008,
    "toPlace": "Beml Nagar",
    "toStateCode": 29,
    "transactionType": 1,
    "totalValue": 5609889.0,
    "totInvValue": 11556371.34,
    "otherValue": -1.0,
    "cessNonAdvolValue": 1.0,
    "toTrdName": "sthuthya",
    "transporterId": "29AAACW6288M1ZH",
    "transporterName": "WELBURN CANDLES PRIVATE LIMITED",
    "userGstin": "29AAACW4202F1ZM",
    "validUpto": "24/01/2023 11:59:00 PM",
    "itemList": [
      {
        "productDesc": "Wheat",
        "cessRate": 0.0,
        "cgstRate": 6.0,
        "hsnCode": 1001,
        "igstRate": 0.0,
        "productId": "0",
        "productName": "Wheat",
        "qtyUnit": "BOX",
        "quantity": 4.0,
        "sgstRate": 6.0,
        "taxableAmount": 5609889.0,
        "itemNo": 1,
        "cessNonAdvol": 0.0
      }
    ],
    "VehiclListDetails": [
      {
        "updMode": "API",
        "vehicleNo": "KA51AB4094",
        "fromPlace": "FRAZER TOWN",
        "fromState": 29,
        "tripshtNo": 0,
        "userGSTINTransin": "29AAACW4202F1ZM",
        "enteredDate": "23/01/2023 12:02:00 PM",
        "transMode": "1",
        "transDocNo": "",
        "transDocDate": "23/01/2023",
        "groupNo": "0"
      }
    ]
  }

Notes#

Below URL is deprecated now. Instead of it please use New URL.
/enriched/ewb/{flynn-version}/eway-bills/verify-ewb