Generate E-Waybill for Non-IRN documents

You can generate an EWB for the document types that are not eligible for IRN by sending a PUT request to E-Invoicing API with the following request headers.

Request URL

PUT: {{HOST}}/einv/v3/ewaybill/generate

Request Headers

PARAMETER

TYPE

DESCRIPTION

X-Cleartax-Auth-Token

String

Mandatory. The auth token generated from ClearTax user id and password.

gstin

String

Mandatory. GSTIN number for the user

Request Parameters

E-waybill Objects

PARAMETER

TYPE

VALIDATIONS

DESCRIPTION

DocumentNumber

String

Max Length 16

Mandatory. Document number

DocumentType

String

INV = Tax Invoice

BOS = Bill of supply

BOE = Bill of entry

CHL = Delivery challan

OTH = Other

Mandatory Document type

DocumentDate

String

Should in format dd/mm/yyyyy

Mandatory. Document date

SupplyType

String

Inward

Outward

Mandatory. Supply Type

SubSupplyTyp

String

1 or Supply

2 or Import

3 or Export

4 or JOB_WORK

5 or OWN_USE

6 or JOB_WORK_RETURNS

7 or SALES_RETURN

8 or OTH

9 or SKD_CKD

10 or LINES_SALES

11 or RECIPIENT_NOT_KNOWN

12 or EXHIBITION_OR_FAIRS

Mandatory. Sub Supply Type

SubSupplyTypeDesc

String

Other Sub Supply Description

TransactionType

String

1 or Regular

2 or Bill to-ship to

3 or Bill from-dispatch from

4 or Combination

Mandatory. Transaction type\

TotalInvoiceAmount

String

Total Invoice value = Taxable amount of the items +

TotalCgstValue + TotalSgstValue + TotalIgstValue

TotalCessAmount + TotalCessNonAdvolAMount +

Other charges at Doc level

(with a grace range of +/- 2)

Mandatory. Total invoice value

TotalCgstAmount

Decimal (18,2)

Conditional. Total CGST value

TotalSgstAmoun

Decimal (18,2)

Conditional. Total SGST value

TotalIgstAmount

Decimal (18,2)

Conditional. Total IGST value

TotalCessAmount

Decimal (18,2)

Optional. Total cess value

TotalCessNonAdvolAmount

Decimal (18,2)

Optional. Cess non Advol value

TotalAssessableAmount

Decimal (18,2)

Optional. Total assessable value

OtherAmount

Decimal (18,2)

Optional. Other values

OtherTcsAmount

Decimal (18,2)

Optional. TCS values

TransId

String

Valid GSTIN

Mandatory for PART-A

Transporter GSTIN or CEN (Common Enrollment Number)

TransName

String

Max Length 100

Mandatory. Transporter name

TransMode

String

Road-1

Rail-2

Air-3

Ship-4

Optional for PART-A otherwise Mandatory

Distance

Number

minimum: 0

maximum: 4000

Mandatory.

Distance between source and destination PIN codes.

If the value is "0" then the distance will be auto-computed by NIC based on the availability of pin-codes in NIC database.

TransDocNo

String

Max Length: 15

Optional when transport mode is ROAD. Transporter document number

TransDocDt

String

Should in format dd/mm/yyyyy

Optional when transport mode is ROAD. Transporter document date

VehNo

String

Valid vehicle number

Mandatory for transport mode ROAD.

VehType

String

REGULAR

ODC

Optional. Vehicle type

Seller, Buyer, Shipping and Dispatch Objects

PARAMETER

VALIDATIONS

TYPE

DESCRIPTION

Gstin

Valid gstin Value / URP

String

Mandatory. GSTIN number

LglNm

Max length of 100

String

Mandatory. Legal name

TrdNm

Max length of 100

String

Optional. Trade Name

Addr1

Max Length 120

String

Mandatory. Address one

Addr2

Max Length 120

String

Optional. Address two

Loc

Max length 50

String

Mandatory. location

valid Pincode

Integer

Optional if dispatch details are present otherwise mandatory. Pincode

Stcd

valid State code with max value of 2

String

Mandatory. State code.

Line Item Objects

PARAMETER

TYPE

DESCRIPTION

ProdName

string

Optional. Product Name

ProdDesc

string

Optional. Product description

HsnCd

Number

Mandatory. Hsn code

Qty

Decimal (8,2)

Mandatory. Quantity

Unit

Text (3)

Mandatory. Unit of measurement

AssAmt

Decimal (18,2)

Mandatory. Assessable amount

CgstRt

Decimal (6,3)

Conditional. CGST rate

CgstAmt

Decimal (18,2)

Optional. CGST Amount

SgstRt

Decimal (6,3)

Conditional. SGST Rate

SgstAmt

Decimal (18,2)

Optional. SGST Amount

IgstRt

Decimal (6,3)

Conditional. IGST Rate

IgstAmt

Decimal (18,2)

Optional. Igst Amount

CesRt

Decimal (6,3)

Optional. Cess Rate

CesAmt

Decimal (18,2)

Optional. Cess amount

OthChrg

Decimal (18,2)

Optional. Other charges

CesNonAdvAmt

Decimal (18,2)

Optional. cess non advol amount.

Enum:

0 or

400 or

2076 or

2747 or

3668 or

4006 or

4170 or

400

Sample Request

{
    "DocumentNumber": "STEST0004",
    "DocumentType": "INV",
    "DocumentDate": "12/10/2023",
    "SupplyType": "OUTWARD",
    "SubSupplyType": "SUPPLY",
    "SubSupplyTypeDesc": "TEST",
    "TransactionType": "Combination",
    "BuyerDtls": {
        "Gstin": "29AWGPV7107B1Z1",
        "LglNm": "XYZ company pvt ltd",
        "TrdNm": "XYZ Industries",
        "Addr1": "7th block, kuvempu layout",
        "Addr2": "kuvempu layout",
        "Loc": "GANDHINAGAR",
        "Pin": 562160,
        "Stcd": "29"
    },
    "SellerDtls": {
        "Gstin": "29AAFCD5862R000",
        "LglNm": "NIC company pvt ltd",
        "TrdNm": "NIC Industries",
        "Addr1": "5th block, kuvempu layout",
        "Addr2": "kuvempu layout",
        "Loc": "GANDHINAGAR",
        "Pin": 560027,
        "Stcd": "29"
    },
    "ExpShipDtls": {
        "LglNm": "ABCD",
        "Addr1": "322 & 323 THIRUVALLUVAR NAGAR NEELI",
        "Addr2": null,
        "Loc": "COIMBATORE",
        "Pin": 641033,
        "Stcd": "33"
    },
    "DispDtls": {
        "Nm": "XYZ",
        "Addr1": "322 & 323 THIRUVALLUVAR NAGAR",
        "Addr2": "2nd cross, apavu nagar",
        "Loc": "Hosur",
        "Pin": 635109,
        "Stcd": "33"
    },
    "ItemList": [
        {
            "ProdName": "Rice",
            "ProdDesc": "test",
            "HsnCd": "1001",
            "Qty": 1,
            "Unit": "BAG",
            "AssAmt": 100,
            "CgstRt": 9,
            "CgstAmt": 9,
            "SgstRt": 9,
            "SgstAmt": 9,
            "IgstRt": 0,
            "IgstAmt": 0,
            "CesRt": 0,
            "CesAmt": 0,
            "OthChrg": 0,
            "CesNonAdvAmt": 0,
            "LineItemCustomFields": {
                "test": "0100"
            }
        }
    ],
    "TotalInvoiceAmount": 118,
    "TotalCgstAmount": 9,
    "TotalSgstAmount": 9,
    "TotalIgstAmount": 0,
    "TotalCessAmount": 0,
    "TotalCessNonAdvolAmount": 0,
    "TotalAssessableAmount": 100,
    "OtherAmount": 0,
    "OtherTcsAmount": 0,
    "TransId": "29AAACW6288M1ZH",
    "TransName": "TRANSPORT",
    "TransMode": "ROAD",
    "Distance": 0,
    "TransDocNo": "TEST-123",
    "TransDocDt": "12/10/2023",
    "VehNo": "KA123456",
    "VehType": "REGULAR",
    "CustomFields": {
        "company number": "104"
    }
}

{
    "DocumentNumber": "STEST0004",
    "DocumentType": "INV",
    "DocumentDate": "12/10/2023",
    "SupplyType": "OUTWARD",
    "SubSupplyType": "SUPPLY",
    "SubSupplyTypeDesc": "TEST",
    "TransactionType": "Combination",
    "BuyerDtls": {
        "Gstin": "29AWGPV7107B1Z1",
        "LglNm": "XYZ company pvt ltd",
        "TrdNm": "XYZ Industries",
        "Addr1": "7th block, kuvempu layout",
        "Addr2": "kuvempu layout",
        "Loc": "GANDHINAGAR",
        "Pin": 562160,
        "Stcd": "29"
    },
    "SellerDtls": {
        "Gstin": "29AAFCD5862R000",
        "LglNm": "NIC company pvt ltd",
        "TrdNm": "NIC Industries",
        "Addr1": "5th block, kuvempu layout",
        "Addr2": "kuvempu layout",
        "Loc": "GANDHINAGAR",
        "Pin": 560027,
        "Stcd": "29"
    },
    "ExpShipDtls": {
        "LglNm": "ABCD",
        "Addr1": "322 & 323 THIRUVALLUVAR NAGAR NEELI",
        "Addr2": null,
        "Loc": "COIMBATORE",
        "Pin": 641033,
        "Stcd": "33"
    },
    "DispDtls": {
        "Nm": "XYZ",
        "Addr1": "322 & 323 THIRUVALLUVAR NAGAR",
        "Addr2": "2nd cross, apavu nagar",
        "Loc": "Hosur",
        "Pin": 635109,
        "Stcd": "33"
    },
    "ItemList": [
        {
            "ProdName": "Rice",
            "ProdDesc": "test",
            "HsnCd": "1001",
            "Qty": 1,
            "Unit": "BAG",
            "AssAmt": 100,
            "CgstRt": 9,
            "CgstAmt": 9,
            "SgstRt": 9,
            "SgstAmt": 9,
            "IgstRt": 0,
            "IgstAmt": 0,
            "CesRt": 0,
            "CesAmt": 0,
            "OthChrg": 0,
            "CesNonAdvAmt": 0,
            "LineItemCustomFields": {
                "test": "0100"
            }
        }
    ],
    "TotalInvoiceAmount": 118,
    "TotalCgstAmount": 9,
    "TotalSgstAmount": 9,
    "TotalIgstAmount": 0,
    "TotalCessAmount": 0,
    "TotalCessNonAdvolAmount": 0,
    "TotalAssessableAmount": 100,
    "OtherAmount": 0,
    "OtherTcsAmount": 0,
    "TransId": "29AAACW6288M1ZH",
    "TransName": "TRANSPORT",
    "TransMode": null,
    "Distance": 0,
    "TransDocNo": "TEST-123",
    "TransDocDt": "12/10/2023",
    "VehNo": null,
    "VehType": null,
    "CustomFields": {
        "company number": "104"
    }
}

Sample Response

{
    "owner_id": null,
    "ewb_status": "GENERATED",
    "ewb_request": {
        "TransId": "29AAACW6288M1ZH",
        "TransName": "TRANSPORT",
        "TransMode": "ROAD",
        "Distance": 0,
        "TransDocNo": "TEST-123",
        "TransDocDt": "12/10/2023",
        "VehNo": "KA123456",
        "VehType": "REGULAR",
        "DispDtls": {
            "Nm": "XYZ",
            "Addr1": "322 & 323 THIRUVALLUVAR NAGAR",
            "Addr2": "2nd cross, apavu nagar",
            "Loc": "Hosur",
            "Pin": 635109,
            "Stcd": "33"
        },
        "ExpShipDtls": {
            "LglNm": "ABCD",
            "Addr1": "322 & 323 THIRUVALLUVAR NAGAR NEELI",
            "Addr2": null,
            "Loc": "COIMBATORE",
            "Pin": 641033,
            "Stcd": "33"
        },
        "BuyerDtls": {
            "Gstin": "29AWGPV7107B1Z1",
            "TrdNm": "XYZ Industries",
            "Addr1": "7th block, kuvempu layout",
            "Addr2": "kuvempu layout",
            "Loc": "GANDHINAGAR",
            "Pin": 562160,
            "Stcd": "29"
        },
        "SellerDtls": {
            "Gstin": "29AAFCD5862R000",
            "TrdNm": "NIC Industries",
            "Addr1": "5th block, kuvempu layout",
            "Addr2": "kuvempu layout",
            "Loc": "GANDHINAGAR",
            "Pin": 560027,
            "Stcd": "29"
        },
        "DocumentNumber": "STEST0004",
        "DocumentType": "INV",
        "DocumentDate": "12/10/2023",
        "SupplyType": "OUTWARD",
        "SubSupplyType": "SUPPLY",
        "SubSupplyTypeDesc": "TEST",
        "TransactionType": "Combination",
        "ItemList": [
            {
                "ProdName": "Rice",
                "ProdDesc": "test",
                "HsnCd": "1001",
                "Qty": 1.000,
                "Unit": "BAG",
                "AssAmt": 100.00,
                "CgstRt": 9.00,
                "CgstAmt": 9.00,
                "SgstRt": 9.00,
                "SgstAmt": 9.00,
                "IgstRt": 0.00,
                "IgstAmt": 0.00,
                "CesRt": 0.00,
                "CesAmt": 0.00,
                "CesNonAdvAmt": 0.00,
                "OthChrg": 0.00,
                "OthChrgTcs": null,
                "LineItemCustomFields": {
                    "test": "0100"
                }
            }
        ],
        "TotalInvoiceAmount": 118.00,
        "IsSupplyToOrSezUnit": null,
        "TotalCgstAmount": 9.00,
        "TotalSgstAmount": 9.00,
        "TotalIgstAmount": 0.00,
        "TotalCessAmount": 0.00,
        "TotalCessNonAdvolAmount": 0.00,
        "TotalAssessableAmount": 100.00,
        "OtherAmount": 0.00,
        "OtherTcsAmount": 0.00,
        "CustomFields": {
            "company number": "104"
        }
    },
    "govt_response": {
        "Success": "Y",
        "Status": "GENERATED",
        "EwbNo": 141010309764,
        "EwbDt": "2024-02-05 12:22:00",
        "EwbValidTill": "2024-02-07 23:59:00"
    },
    "transaction_id": "29AAFCD5862R000_STEST0004_INV_2023"
}

{
    "owner_id": null,
    "ewb_status": null,
    "ewb_request": {
        "TransId": "29AAACW6288M1ZH",
        "TransName": "ABC",
        "TransMode": "ROAD",
        "Distance": 0,
        "TransDocNo": null,
        "TransDocDt": null,
        "VehNo": "KA123456",
        "VehType": "REGULAR",
        "DispDtls": {
            "Addr1": "322 & 323 THIRUVALLUVAR NAGAR",
            "Addr2": "2nd cross, apavu nagar",
            "Loc": "Hosur",
            "Pin": 635109,
            "Stcd": "33"
        },
        "ExpShipDtls": {
            "LglNm": "ABC",
            "Addr1": "322 & 323 THIRUVALLUVAR NAGAR NEELI",
            "Addr2": "Test2",
            "Loc": "COIMBATORE",
            "Pin": 641033,
            "Stcd": "33"
        },
        "BuyerDtls": {
            "Gstin": "29AAFCD5862R1ZR",
            "TrdNm": "XYZ Industries",
            "Addr1": "7th block, kuvempu layout",
            "Addr2": "kuvempu layout",
            "Loc": "GANDHINAGAR",
            "Pin": 562160,
            "Stcd": "29"
        },
        "SellerDtls": {
            "Gstin": "07AAFCD5862R007",
            "TrdNm": "NIC Industries",
            "Addr1": "5th block, kuvempu layout",
            "Addr2": "kuvempu layout",
            "Loc": "GANDHINAGAR",
            "Pin": 110001,
            "Stcd": "07"
        },
        "DocumentNumber": "WAREWB68",
        "DocumentType": "CHL",
        "DocumentDate": "12/10/2023",
        "SupplyType": "OUTWARD",
        "SubSupplyType": "Job Work",
        "SubSupplyTypeDesc": "TEST",
        "TransactionType": "Regular",
        "ItemList": [
            {
                "ProdName": "Rice",
                "ProdDesc": "test",
                "HsnCd": "1001",
                "Qty": 1.000,
                "Unit": "BAG",
                "AssAmt": 100.00,
                "CgstRt": 0.00,
                "CgstAmt": 0.00,
                "SgstRt": 0.00,
                "SgstAmt": 0.00,
                "IgstRt": 0.00,
                "IgstAmt": 0.00,
                "CesRt": 0.00,
                "CesAmt": 0.00,
                "CesNonAdvAmt": 0.00,
                "OthChrg": 0.00,
                "OthChrgTcs": null,
                "LineItemCustomFields": null
            }
        ],
        "TotalInvoiceAmount": 100.00,
        "IsSupplyToOrSezUnit": null,
        "TotalCgstAmount": 0.00,
        "TotalSgstAmount": 0.00,
        "TotalIgstAmount": 0.00,
        "TotalCessAmount": 0.00,
        "TotalCessNonAdvolAmount": 0.00,
        "TotalAssessableAmount": 100.00,
        "OtherAmount": 0.00,
        "OtherTcsAmount": 0.00,
        "CustomFields": null
    },
    "govt_response": {
        "Success": "N",
        "ErrorDetails": [
            {
                "error_code": "107",
                "error_message": "transactionType : Invalid Transaction Type. Transaction Type should be Combination of 2 & 3 when Buyer, seller, shipping and dispatch State Codes or Pin codes are not equal. Please correct the Transaction Type value and try again",
                "error_source": "CLEARTAX"
            }
        ]
    },
    "transaction_id": null
}

PreviousGenerate E-Waybill by IRN NextCancel E-Waybill

Last updated 5 months ago