1. Generate EWB

This API will allow user to generate EWB based on a new invoice payload as defined by the IRIS Topaz EWB input format.

For Input format -> First Log in to IRIS Topaz -> Go to resource section -> Utilities -> Click on E-way bill data field. Input format will get downloaded.

Request Parameters

The input parameters will be supported in the API request are as below:

  • X-Auth-Token: A authentication token that needs to passed in all requests

  • Root Company ID: The unique identifier (corresponds to the root Business) of a company in IRIS TOPAZ system that authorizes the user’s subsequent requests.

  • (optional)Company ID: The company ID (should correspond to a Place of Business) for which user wants to post the request. The company ID will default to Principal Place of Business if left blank.

  • Invoice Object: Data as per IRIS Topaz input format 

  • Force Duplicate Check: A Boolean value which if true will result in Topaz system rejecting duplicate invoices while generating an EWB.

The API will respond with an enveloped response with a collection of results object. The response information is as below:

  • Status: Success/Failure for the Invoice object.

  • EWB Details: EWB number, EWB generated date and EWB Status (See Annexures for a list of IRIS EWB statuses)

  • List of Errors with short description: In case of Failure, user will get short descriptions of errors for the invoice object.

Sample Request and Response

URL

https://esp.api.irisgst.com/api/v0.3/ewb

Method

POST

Headers

Content-Type:application/json

X-Auth-Token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJwcmthbWJsZUBtYWlsaW5hdG9yLmNvbSIsImF1ZGllbmNlIjoid2ViIiwiY3JlYXRlZCI6MTUyMDI2NjU2MzYzOSwiZXhwIjoxNTIwJ0ZW5hbnQiOiJkZXYifQ.-NdGYNyUV7j_tLpBdTvDbv3cuUMPFnl1sl4prLFIKsXVohe4Xmdg4ng3eC6wndLhFNlIgC8jkjuBO7KtJKfd3g

companyId:1

Body

{

    "supplyType": "I",

    "subSupplyType":2,

    "docType": "INV",

    "docNo": "243S1234",

    "docDate": "22/03/2018",

    "invType":"B2B",

     "referencInum":"08AEMPJ6626D1ZG1",

     "referenceIdt":"21/03/2018",

    

    "fromGstin": "05AZZXX1077P1Z9",

    "fromTrdName": "RJ-Reddy Traders",

    "fromAddr1": "T231",

    "fromAddr2": "IIP",

    "fromPlace": "Akodiya",

    "fromStateCode":8,

    "fromPincode": 300703,

    "toGstin": "05AZZXX1077P1Z9",

    "toTrdName": "RJ-Rawat Foods",

    "toAddr1": "S531, SSB Towers",

    "toAddr2": "MG Road",

    "toPlace": "Bangaluru",

    "toPincode": 326030,

    "toStateCode": 8,

    "totalValue": 0,

    "cgstValue":12545,

    "sgstValue":12545,

    "igstValue": 30000,

    "cessValue": 3000,

   

    "transMode": 1,

    "transDistance": 206,

    "transDocNo": "TR1234",

    "transDocDate": "23/03/2018",

    "transporterId":"08ABBXX6626D1ZG",

    "transporterName":"ACVDF",

    "vehicleType":"R",

    "vehicleNo":"MH12HJ1212",

    

    "itemList": [

      {

        "productName": "Sugar",

        "productDesc": "Sugar",

        "hsnCode": "66",

        "quantity": 10,

        "qtyUnit": "KGS",

        "taxableAmount": 1.00,

        "sgstRate": 6,

        "cgstRate": 6,

        "igstRate": 0,

        "cessRate": 1,

        "txp":"T"

      },

       {

       

        "productName": "Sugar",

        "productDesc": "Sugar",

        "hsnCode": "66",

        "quantity": 10,

        "qtyUnit": "KGS",

        "taxableAmount": 1.00,

        "sgstRate": 6,

        "cgstRate": 6,

        "igstRate": 0,

        "cessRate": 1,

        "txp":"L"

      }

    ],

  "companyId”: 1,

  "userGstin":"05AZZXX1077P1Z9",

  "forceDuplicateCheck":true

}

Response

-SUCCESS

{

    "status": "SUCCESS",

    "errorList": null,

    "message": "E - Way bill generated successfully",

    "fieldErrors": null,

    "errors": null,

    "response": {

        "ewbNo": "341001002320",

        "supplyType": "O",

        "subSupplyType": "1",

        "docType": "INV",

        "docNo": "243S1234",

        "docDate": "22/03/2018",

        "fromGstin": "05BCDEW1077P1Z0",

        "fromTrdName": "Testing 123",

        "fromAddr1": "T231",

        "fromAddr2": "IIP",

        "fromPlace": "Akodiya",

        "fromPincode": "300703",

        "fromStateCode": "8",

        "toGstin": "05AAAAU1183B5ZW",

        "toTrdName": "Active Invalid 34",

        "toAddr1": "S531, SSB Towers",

        "toAddr2": "MG Road",

        "toPlace": "Bangaluru",

        "toPincode": "326030",

        "toStateCode": "8",

        "totalValue": 123,

        "cgstValue": 12545,

        "sgstValue": 12545,

        "igstValue": 30000,

        "cessValue": 3000,

        "transporterId": "08AEMPJ6626D1ZG",

        "transporterName": "ACVDF",

        "transDocNo": "TR1234",

        "transMode": "1",

        "transDistance": "206",

        "transDocDate": "23/03/2018",

        "vehicleNo": "MH12AB1234",

        "vehicleType": "R",

        "itemList": [

            {

                "productName": "Sugar",

                "productDesc": "Sugar",

                "hsnCode": "01",

                "quantity": "10",

                "qtyUnit": "KGS",

                "cgstRate": 0,

                "sgstRate": 0,

                "igstRate": 12,

                "cessRate": 1,

                "taxableAmount": 1

            },

            {

                "productName": "Sugar",

                "productDesc": "Sugar",

                "hsnCode": "66",

                "quantity": "10",

                "qtyUnit": "KGS",

                "cgstRate": 6,

                "sgstRate": 6,

                "igstRate": 0,

                "cessRate": 1,

                "taxableAmount": 1

            }

        ],

        "userGstin": "05BCDEW1077P1Z0",

        "ewbDate": "22/04/2018 07:12:00 AM",

        "validUpto": "25/04/2018 11:59:00 AM",

        "rejectStatus": "N",

        "status": "ACTIVE",

        "reqGstin": "05BCDEW1077P1Z0",

        "generatedBy": "prkamble@email.com",

        "generatedOn": "22/04/2018 07:12:04 AM"

    }

}

Response

(FAILURE,NIC response )

{

    "status": "FAILURE",

    "errorList": null,

    "message": "Problem in generating E - Way bill",

    "fieldErrors": null,

    "errors": null,

    "response": [

        "ewbErrorList": [

        {

            "ewbErrorCode": 216,

            "ewbErrorDesc": "Invalid HSN Code"

        }

       ]

    ]

}

Response

(FAILURE,

Structural rule and business rules check at IRIS)

{

    "status": "FAILURE",

    "errorList": null,

    "message": "Validation Failure",

    "fieldErrors": null,

    "errors": [

        {

            "codes": null,

            "arguments": null,

            "defaultMessage": "Invalid value supplied in transDocDate. Check IRIS EWB Input Format",

            "objectName": "generateEwbRequestModel",

            "field": "transDocDate",

            "rejectedValue": "22-02-2018",

            "bindingFailure": true,

            "code": null

        }

    ],

    "response": null

}

2. Vehicle Number Update

This API will allow companies to update Part B or Vehicle details of EWB.

Request Parameters

The input parameters will be supported in the API request are as below:

  • X-Auth-Token: A authentication token that needs to passed in all subsequent requests

  • Root Company ID: The unique identifier (corresponds to the root Business) of a company in IRIS TOPAZ system that authorizes the user’s subsequent requests.

  • (optional)Company ID: The company ID (corresponds to a Business/Legal/Filing/Place of Business) for which user wants to post the request.

  • EWB Number: Unique 12 digit EWB number

  • Transportation Mode: One of Road/Rail/Air/Ship.

  • (optional) Vehicle No.: Vehicle number associated with EWB. Required if transportation mode is Road.

  • From Place: Starting place of the trip

  • From State: Starting state of the trip

  • Reason Code: Reason for updating vehicle details (See Annexure for valid reasons)

  • (optional) Reason Remarks: Mandatory if Reason Code is 3 (Others).

  • (optional)Transport Doc. No.: Required if transportation mode is Rail/Air/Ship.

  • (optional)Transportation Doc. Date: Required if transportation mode is Rail/Air/Ship.

Response Parameters

The API will respond with an enveloped response with a collection of results object. The response information is as below:

  • Status: Success/Failure

  • Vehicle Update Date: Date on which the vehicle details were updated.

  • List of Errors: In case of Failure a list of errors with short description

URL

https://esp.api.irisgst.com/api/v0.3/ewb

Method

PUT

Headers

Content-Type:application/json

X-Auth-Token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJwcmthbWJsZUBtYWlsaW5hdG9yLmNvbSIsImF1ZGllbmNlIjoid2ViIiwiY3JlYXRlZCI6MTUyMDI2NjU2MzYzOSwiZXhwIjoxNTIwODcxMzYzLCJ0ZW5hbnQiOiJkZXYiDbv3cuUMPFnl1sl4prLFIKsXVohe4Xmdg4ng3eC6wndLhFNlIgC8jkjuBO7KtJKfd3g

companyId:1

Body

{

      "ewbNo": 371000795756,

      "vehicleNo": "MH17AJ4849",

      "fromPlace": "Kanpur",

      "fromState": 24,

      "reasonCode": "1",

      "reasonRem": "vehicle broke down",

      "transDocNo ": null,

      "transDocDate ": null,

      "transMode": 1

      "userGstin":"08ACABJ8289N1ZX",

      "action":"UPDATE"

}

 

 

Response

(SUCCESS)

{

    "status": "SUCCESS",

    "errorList": null,

    "message": null,

    "fieldErrors": null,

    "errors": null,

    "response": {

        "ewbNo": "341001002320",

        "updateDate": "22/04/2018 07:49:00",

        "validUpto": "25/04/2018 23:59:00",

        "status": "ACTIVE",

        "vehicleNo": "MH12AJ5477"

    }

}

Response

(NIC Errors, error codes with short description)

 

{

    "status": "FAILURE",

    "errorList": null,

    "message": "Problem while performing operation",

    "fieldErrors": null,

    "errors": null,

    "response": {

        "ewbErrorList": [

            {

                "ewbErrorCode": 308,

                "ewbErrorDesc": "Invalid remarks"

            }

        ]

    }

}

Response

(FAILURE)

{

    "status": "FAILURE",

    "errorList": null,

    "message": "Validation Failure",

    "fieldErrors": null,

    "errors":

        {

            "codes": null,

            "arguments": null,

            "defaultMessage": "ewbNo may not be blank",

            "objectName": "ewbOperationReqModel",

            "field": "list[0].ewbNo",

            "rejectedValue": null,

            "bindingFailure": true,

            "code": null

        },

    "response": null

}

3. Reject EWBs

This API will allow user to reject an EWB generated against him by a counter-party.

Request Parameters

The input parameters will be supported in the API request are as below:

  • X-Auth-Token: A authentication token that needs to passed in all subsequent requests

  • Root Company ID: The unique identifier (corresponds to the root Business) of a company in IRIS TOPAZ system that authorizes the user’s subsequent requests.

  • Company ID: The company ID (corresponds to a Business/Legal/Filing/Place of Business) for which user wants to post the request.

  • EWB Number

Response Parameters

The API will respond with an enveloped response with a collection of results object. The response information is as below:

  • Status: Success/Failure

  • Rejected Date: Date on which the EWB was rejected.

  • List of Errors: In case of Failure a list of errors with short description

URL

https://esp.api.irisgst.com/api/v0.3/ewb

Method

PUT

Headers

Content-Type:application/json

X-Auth-Token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJwcmthbWJsZUBtYWlsaW5hdG9yLmNvbSIsImF1ZGllbmNlIjoid2ViIiwiY3JlYXRlZCI6MTUyMDI2NjU2MzYzOSwiZXhwIjoxNTIwODcxMzYzLCJ0ZdTvDbv3cuUMPFnl1sl4prLFIKsXVohe4Xmdg4ng3eC6wndLhFNlIgC8jkjuBO7KtJKfd3g

companyId:1

Body

{

  "ewbNo": "381000795759”,

  "userGstin":"08ABCPJ8289N1ZX",

  "action":"REJECT"

}

 

Response

(SUCCESS)

{

    "status": "SUCCESS",

    "errorList": null,

    "message": null,

    "fieldErrors": null,

    "errors": null,

    "response": {

        "ewbNo": "381000795759",

        "rejectDate": "22/04/2018 07:59:00",

        "rejectStatus": "R",

        "status": "ACTIVE"

    }

}

Response

(FAILURE)

{

    "status": "SUCCESS",

    "errorList": null,

    "message": null,

    "fieldErrors": null,

    "errors": null,

    "response": {

            "ewbErrorList": [

                {

                    "ewbErrorCode": 239,

                    "ewbErrorDesc": " Invalid action "

                }

            ]

        }

}

4. Cancel EWB

 This API will allow user to cancel an EWB generated by him/her.

Request Parameters

The input parameters will be supported in the API request are as below:

  • X-Auth-Token: A authentication token that needs to passed in all subsequent requests

  • Root Company ID: The unique identifier (corresponds to the root Business) of a company in IRIS TOPAZ system that authorizes the user’s subsequent requests.

  • Company ID: The company ID (corresponds to a Business/Legal/Filing/Place of Business) for which user wants to post the request.

  • EWB Number

  • Cancel Reason Code: (See Annexure for valid cancel reason code)

  • (optional) Cancel Remark: Required if Cancel Reason code is 4 (Others)

Response Parameters

The API will respond with an enveloped response with a collection of results object. The response information is as below:

  • Status: Success/Failure

  • Cancelled Date: Date on which the EWB was cancelled.

  • List of Errors: In case of Failure a list of errors with short description

URL

https://esp.api.irisgst.com/api/v0.3/ewb

Method

PUT

Headers

Content-Type:application/json

X-Auth-Token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJwcmthbWJsZUBtYWlsaW5hdG9yLmNvbSIsImF1ZGllbmNlIjoid2ViIiwiY3JlYXRlZCI6MTUyMDI2NjU2MzYzOSwiZXhwIjoxNTIwODcxMzYzLCJ0Dbv3cuUMPFnl1sl4prLFIKsXVohe4Xmdg4ng3eC6wndLhFNlIgC8jkjuBO7KtJKfd3g

companyId:1

Body

{

 

      "ewbNo": "381000795759",

      "cancelRsnCode": "2",

      "cancelRmrk": "Cancelled the order"

      "userGstin":"08ABCPJ8289N1ZX",

      "action":"CANCEL"

}

 

Response

(SUCCESS)

{

    "status": "SUCCESS",

    "errorList": null,

    "message": null,

    "fieldErrors": null,

    "errors": null,

    "response": {

        "ewbNo": "391001000738",

        "cancelDate": "20/04/2018 07:50:00",

        "status": "CANCEL"

    }

}

Response

(NIC Errors, error codes with short description)

{

    "status": "FAILURE",

    "errorList": null,

    "message": "Problem while performing operation",

    "fieldErrors": null,

    "errors": null,

    "response": {

        "ewbErrorList": [

            {

                "ewbErrorCode": 312,

                "ewbErrorDesc": "This eway bill is either not generated by you or cancelled"

            }

        ]

    }

}

Response

(FAILURE)

{

    "status": "FAILURE",

    "errorList": null,

    "message": "Validation Failure",

    "fieldErrors": null,

    "errors": {

            "codes": null,

            "arguments": null,

            "defaultMessage": "ewbNo may not be blank",

            "objectName": "ewbOperationReqModel",

            "field": "list[0].ewbNo",

            "rejectedValue": null,

            "bindingFailure": true,

            "code": null

        },

"response": null

}

5. Generate Consolidated EWB

This API will allow user to generate Consolidated EWB as defined by the IRIS Topaz EWB input format. (See Annexure)

Request Parameters

The inputs parameters will be supported in the API request are as below:

  • X-Auth-Token: A authentication token that needs to passed in all subsequent requests

  • Root Company ID: The unique identifier (corresponds to the root Business) of a company in IRIS TOPAZ system that authorizes the user’s subsequent requests.

  • (optional)Company ID: The company ID (corresponds to a Business/Legal/Filing/Place of Business) for which user wants to post the request.

  • From Place: Starting place of the trip

  • From State: Starting state of the trip

  • Transportation Mode: One of Road/Rail/Air/Ship.

  • (optional) Vehicle No.: Vehicle number associated with EWB. Required if transportation mode is Road.

  •  (optional)Transport Doc. No.: Required if transportation mode is Rail/Air/Ship.

  • (optional)Transportation Doc. Date: Required if transportation mode is Rail/Air/Ship.

  • Trip Sheet Eway Bill Number: Required E-way bill Numbers which the user wants to consolidate.

Response Parameters

The API will respond with an enveloped response with a collection of results object. The response information is as below:

  • Status: Success/Failure

  • Consolidated EWB Details: Consolidated EWB number, Consolidated EWB generated date (See Annexures for a list of IRIS EWB statuses)

  • List of Errors: In case of Failure a list of errors with short description

Sample Request and Response

URL

https://esp.api.irisgst.com/api/v0.3/cewb

 

Method

POST

Headers

Content-Type:application/json

X-Auth-Token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJwcmthbWJsZUBtYWlsaW5hdG9yLmNvbSIsImF1ZGllbmNlIjoid2ViIiwiY3JlYXRlZCI6MTUyMDI2NjU2MzYzOSwiZXhwIjoxNTIwJ0ZW5hbnQiOiJkZXYifQ.-NdGYNyUV7j_tLpBdTvDbv3cuUMPFnl1sl4prLFIKsXVohe4Xmdg4ng3eC6wndLhFNlIgC8jkjuBO7KtJKfd3g

companyId:1

Body

{

  "fromPlace": "BANGALORE SOUTH",

  "fromState": "29",

  "vehicleNo": "",

  "transMode": "3",

  "transDocNo":"1234",

  "transDocDate":"22/10/2018",

  "tripSheetEwbBills": ["321001542536","371001542515"],

 

  "userGstin":"05AAAAT2562R1Z3"

 

 

}

Response

-SUCCESS

{

    "status": "SUCCESS",

    "errorList": null,

    "message": "Consolidated E - Way bill generated successfully",

    "fieldErrors": null,

    "errors": null,

    "response": {

        "cEwbNo": "3310017517",

        "cEwbDate": "22/10/2018 12:02:00"

    }

}

Response

(FAILURE,NIC response )

{

    "status": "FAILURE",

    "errorList": null,

    "message": "Probelm in generating consolidated E - Way bill",

    "fieldErrors": null,

    "errors": null,

    "response": [

        {

            "ewbErrorCode": 311,

            "ewbErrorDesc": "Validity period lapsed, you cannot update vehicle details"

        }

    ]

}

Response

(FAILURE,

Structural rule and business rules check at IRIS)

{

    "status": "FAILURE",

    "errorList": null,

    "message": "Validation Failure",

    "fieldErrors": [

        {

            "codes": null,

            "arguments": null,

            "defaultMessage": "Missing mandatory field fromStateCode. Check IRIS EWB Input Format",

            "objectName": "consolidatedEwbRequestModel",

            "field": "fromState",

            "rejectedValue": "",

            "bindingFailure": true,

            "code": null

        },

        {

            "codes": null,

            "arguments": null,

            "defaultMessage": "Missing mandatory field fromStateCode. Check IRIS EWB Input Format",

            "objectName": "consolidatedEwbRequestModel",

            "field": "fromState",

            "rejectedValue": "",

            "bindingFailure": true,

            "code": null

        },

        {

            "codes": null,

            "arguments": null,

            "defaultMessage": "Invalid value supplied in fromStateCode. Check IRIS EWB Input Format",

            "objectName": "consolidatedEwbRequestModel",

            "field": "fromState",

            "rejectedValue": "",

            "bindingFailure": true,

            "code": null

        }

    ],

    "errors": null,

    "response": null

}



6. Update Transporter

This API will allow companies to update Transporter assigned for an E-way bill.

Request Parameters

The inputs parameters will be supported in the API request are as below:

  • X-Auth-Token: A authentication token that needs to passed in all subsequent requests
  • Root Company ID: The unique identifier (corresponds to the root Business) of a company in IRIS TOPAZ system that authorizes the user’s subsequent requests.
  • (optional)Company ID: The company ID (corresponds to a Business/Legal/Filing/Place of Business) for which user wants to post the request. 
  • EWB Number: Unique 12 digit EWB number
  • Transporter ID: Transporter ID that needs to be updated in the E-way bill
  • User GSTIN: The GSTIN of the taxpayer who is updating the E-way bill

Response Parameters

The API will respond with an enveloped response with a collection of results object. The response information is as below:

  • Status: Success/Failure
  • Transporter ID Update Date: Date on which the transporter ID was updated.
  • List of Errors: In case of Failure a list of errors with short description

URL

https://esp.api.irisgst.com/api/v0.3/transporter

 

Method

POST

Headers

Content-Type:application/json

X-Auth-Token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJwcmthbWJsZUBtYWlsaW5hdG9yLmNvbSIsImF1ZGllbmNlIjoid2ViIiwiY3JlYXRlZCI6MTUyMDI2NjU2MzYzOSwiZXhwIjoxNTIwODcxMzYzLCJ0ZW5hbnQiOiJkZXYiDbv3cuUMPFnl1sl4prLFIKsXVohe4Xmdg4ng3eC6wndLhFNlIgC8jkjuBO7KtJKfd3g

companyId:1

Body

{

 

     "ewbNo":"301001078486",

     "transporterId":"08ACABJ8289N1ZX",

     "userGstin": “08ACABJ8289N1ZX",

     "companyId":2393

   

}

Response

(SUCCESS)

{

    "status": "SUCCESS",

    "errorList": null,

    "message": "Transporter details updated successfully",

    "fieldErrors": null,

    "errors": null,

    "response": {

        "ewbNo": "301001078486",

        "transporterId": "08ACABJ8289N1ZX",

        "userGstin": "08ACABJ8289N1ZX",

        "transUpdateDate": "24/05/2018 02:15:08"

    }

}

 

Response

(NIC Errors, error codes with short description)

{

    "status": "FAILURE",

    "errorList": null,

    "message": "Problem in updating transporter details",

    "fieldErrors": null,

    "errors": null,

    "response": {

        "ewbErrorList": [

            {

                "ewbErrorCode": 384,

                "ewbErrorDesc": "You are not current transporter or Generator of the ewayBill, with no transporter details."

            }

        ]

    }

}

Response

(FAILURE)

{{

    "status": "FAILURE",

    "errorList": null,

    "message": "Validation Failure",

    "fieldErrors": [

        {

            "codes": null,

            "arguments": null,

            "defaultMessage": "Invalid value supplied in userGstin. Check IRIS EWB Input Format",

            "objectName": "transporterOperModel",

            "field": "userGstin",

            "rejectedValue": "null",

            "bindingFailure": true,

            "code": null

        }

    ],

    "errors": null,

    "response": null

}


7. Extend Validity

This API will allow companies to update Part B or Vehicle details of EWB.

Request Parameters

The inputs parameters will be supported in the API request are as below:

  • X-Auth-Token: A authentication token that needs to passed in all subsequent requests
  • Root Company ID: The unique identifier (corresponds to the root Business) of a company in IRIS TOPAZ system that authorizes the user’s subsequent requests.
  • (optional)Company ID: The company ID (corresponds to a Business/Legal/Filing/Place of Business) for which user wants to post the request.
  • EWB Number: Unique 12 digit EWB number
  • Transportation Mode: One of Road/Rail/Air/Ship.
  • Remaining Distance: Distance remaining to destination pincode from current location
  • (optional) Vehicle No.: Vehicle number associated with EWB. Required if transportation mode is Road.
  • From Place: Place from where EWB is being updated
  • From State: State from where EWB is being updated
  • Extension Reason Code: Reason for updating vehicle details (See Annexure for valid reasons)
  • (optional) Extension Reason Remarks: Remarks (if any).
  • (optional) Transport Doc. No.: Required if transportation mode is Rail/Air/Ship.
  • (optional) Transportation Doc. Date: Required if transportation mode is Rail/Air/Ship.

Response Parameters

The API will respond with an enveloped response with a collection of results object. The response information is as below:

  • Status: Success/Failure
  • Update Date: Date on which the EWB was extended.
  • Valid Upto: New Valid Upto date
  • List of Errors: In case of Failure a list of errors with short description

URL

https://esp.api.irisgst.com/api/v0.3/ewb

 

Method

PUT

Headers

Content-Type:application/json

X-Auth-Token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJwcmthbWJsZUBtYWlsaW5hdG9yLmNvbSIsImF1ZGllbmNlIjoid2ViIiwiY3JlYXRlZCI6MTUyMDI2NjU2MzYzOSwiZXhwIjoxNTIwODcxMzYzLCJ0ZW5hbnQiOiJkZXYiDbv3cuUMPFnl1sl4prLFIKsXVohe4Xmdg4ng3eC6wndLhFNlIgC8jkjuBO7KtJKfd3g

companyId:1

Body

{

     "ewbNo": 371000795756,

     "vehicleNo": "TN000001",

     "fromPlace":"COIMBATORE",

     "fromState":33,

     "remainingDistance":10,

     "transDocNo": "1234",

     "transDocDate": "12/05/2018",

     "transMode": "1",

     "extnRsnCode":1,

     "extnRemarks":"Natural Calamity",

     "fromPincode":"560090",

     "consignmentStatus":"T",

     "transitType":"R",

     "addressLine1":"Bengaluru",

     "addressLine2":"Bengaluru",

     "addressLine3":"Bengaluru",

     "userGstin": "08ACABJ8289N1ZX",

     "companyId":1,

     "action":"extendvalidity"

}

Response

(SUCCESS)

{

    "status": "SUCCESS",

    "errorList": null,

    "message": null,

    "fieldErrors": null,

    "errors": null,

    "response": {

        "ewbNo": "341001002320",

        "updateDate": "22/04/2018 07:49:00",

        "validUpto": "25/04/2018 23:59:00"

    }

}

Response

(NIC Errors, error codes with short description)

 

{

    "status": "FAILURE",

    "errorList": null,

    "message": "Problem while performing operation",

    "fieldErrors": null,

    "errors": null,

    "response": {

        "ewbErrorList": [

            {

                "ewbErrorCode": 382,

                "ewbErrorDesc": "You Cannot Extend as EWB can be Extended only 8 hour before or after w.r.t Validity of EWB..!!"

            }

        ]

    }

}

Response

(FAILURE)

{

    "status": "FAILURE",

    "errorList": null,

    "message": "Validation Failure",

    "fieldErrors": [

        {

            "codes": null,

            "arguments": null,

            "defaultMessage": "ewbNo may not be empty",

            "objectName": "ewbOperationReqModel",

            "field": "ewbNo",

            "rejectedValue": "",

            "bindingFailure": true,

            "code": null

        },

        {

            "codes": null,

            "arguments": null,

            "defaultMessage": "ewbNo may not be blank",

            "objectName": "ewbOperationReqModel",

            "field": "ewbNo",

            "rejectedValue": "",

            "bindingFailure": true,

            "code": null

        }

    ],

    "errors": null,

    "response": null

}