> ## Documentation Index > Fetch the complete documentation index at: https://developer.sandbox.co.in/llms.txt > Use this file to discover all available pages before exploring further. # Generate E-Way Bill > Generate E-Way Bill by providing consignor, consignee, transporter and products details. #### Request body schema ## OpenAPI ````yaml api-reference/gst/compliance/openapi.json POST /gst/compliance/e-way-bill/consignor/bill openapi: 3.0.1 info: title: compliance description: >- **GST Compliance API** enables businesses to automate compliance requirements like [Taxpayer verification](https://developer.sandbox.co.in/reference/search-gstin-api), [GSTR Filing](https://developer.sandbox.co.in/reference/gst-taxpayer-authentication), [Generating E-Invoices](https://developer.sandbox.co.in/reference/e-invoice-authentication-api), and [E-Way Bills](https://developer.sandbox.co.in/reference/e-way-bill-authentication-api).We provide these APIs from GSTN-authorised GST Suvidha Providers, handling the encryption-decryption and signing so you don't have to handle the complexities. version: 1.0.0 servers: - url: https://api.sandbox.co.in - url: https://test-api.sandbox.co.in security: [] tags: - name: Public - name: Taxpayer - name: Taxpayer Auth - name: Returns - name: GSTR-1 Documents - name: File GSTR-1 - name: GSTR-2A Documents - name: GSTR-2B Document - name: File GSTR-3B - name: GSTR-4 - name: File GSTR-9 - name: Invoice Management System - name: GSTR-1A Documents - name: File GSTR-1A - name: Ledgers - name: e-Invoice - name: Sales e-Invoices for return period - name: Purchase e-Invoices for return period - name: Front Office Notices - name: Front Office - name: AATO - name: e-Invoice1 - name: Authentication - name: e-Invoice12 - name: E-Way Bill - name: E-Way Bill1 - name: Authentication1 - name: Consignor - name: Consolidated E-Way Bill - name: Multi-Vehicle Movement - name: Consignee - name: Transporter - name: Consolidated E-Way Bill1 - name: Multi-vehicle Movement - name: Common paths: /gst/compliance/e-way-bill/consignor/bill: post: tags: - E-Way Bill1 - Consignor summary: Generate E-Way Bill operationId: generateEWayBill parameters: - name: authorization in: header description: >- E-Way Bill access token. For token-generation steps, refer to the [Generate E-Way Bill Session](/recipes/gst/authentication/generate_e_way_bill_session) recipe, then pass the token in the authorization header. required: true example: '' schema: type: string - name: x-api-version in: header description: API version required: false example: '' schema: type: string default: 1.0.0 - name: x-api-key in: header description: API key for identification required: true example: '' schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GenerateEWayBillRequest' examples: 212 Invalid Consignee GSTIN: value: supplyType: O subSupplyType: '1' subSupplyDesc: '' docType: INV docNo: 7001-8 docDate: 15/12/2017 fromGstin: 29AAACQ3770E000 fromTrdName: welton fromAddr1: 2ND CROSS NO 59 19 A fromAddr2: GROUND FLOOR OSBORNE ROAD fromPlace: FRAZER TOWN fromPincode: 560090 actFromStateCode: 29 fromStateCode: 29 toGstin: 02EHFPS5910D2Z0 toTrdName: sthuthya toAddr1: Shree Nilaya toAddr2: Dasarahosahalli toPlace: Beml Nagar toPincode: 560090 actToStateCode: 29 toStateCode: 27 transactionType: 4 otherValue: -100 totalValue: 56099 cgstValue: 0 sgstValue: 0 igstValue: 300.67 cessValue: 400.56 cessNonAdvolValue: 400 totInvValue: 68358 transporterId: 27AAACQ3770E004 transporterName: '' transDocNo: '' transMode: '1' transDistance: '100' transDocDate: '' vehicleNo: PVC1234 vehicleType: R itemList: - productName: Wheat productDesc: Wheat hsnCode: 1001 quantity: 4 qtyUnit: BOX cgstRate: 0 sgstRate: 0 igstRate: 3 cessRate: 3 cessNonadvol: 0 taxableAmount: 5609889 summary: 212 Invalid Consignee GSTIN 702 Distance between pincodes is too high or low: value: supplyType: O subSupplyType: '1' subSupplyDesc: '' docType: INV docNo: 7001-8 docDate: 15/12/2017 fromGstin: 29AAACQ3770E000 fromTrdName: welton fromAddr1: 2ND CROSS NO 59 19 A fromAddr2: GROUND FLOOR OSBORNE ROAD fromPlace: FRAZER TOWN fromPincode: 400027 actFromStateCode: 27 fromStateCode: 27 toGstin: 27AAACQ3770E000 toTrdName: sthuthya toAddr1: Shree Nilaya toAddr2: Dasarahosahalli toPlace: Beml Nagar toPincode: 560090 actToStateCode: 29 toStateCode: 29 transactionType: 4 otherValue: -100 totalValue: 56099 cgstValue: 0 sgstValue: 0 igstValue: 300.67 cessValue: 400.56 cessNonAdvolValue: 400 totInvValue: 68358 transporterId: 27AAACQ3770E004 transporterName: '' transDocNo: '' transMode: '1' transDistance: '100' transDocDate: '' vehicleNo: PVC1234 vehicleType: R itemList: - productName: Wheat productDesc: Wheat hsnCode: 1001 quantity: 4 qtyUnit: BOX cgstRate: 0 sgstRate: 0 igstRate: 3 cessRate: 3 cessNonadvol: 0 taxableAmount: 5609889 summary: 702 Distance between pincodes is too high or low 200 EWB generated with alert: value: supplyType: O subSupplyType: '1' subSupplyDesc: '' docType: INV docNo: 7001-8 docDate: 15/12/2017 fromGstin: 29AAACQ3770E000 fromTrdName: welton fromAddr1: 2ND CROSS NO 59 19 A fromAddr2: GROUND FLOOR OSBORNE ROAD fromPlace: FRAZER TOWN fromPincode: 400027 actFromStateCode: 27 fromStateCode: 27 toGstin: 27AAACQ3770E000 toTrdName: sthuthya toAddr1: Shree Nilaya toAddr2: Dasarahosahalli toPlace: Beml Nagar toPincode: 560090 actToStateCode: 29 toStateCode: 29 transactionType: 4 otherValue: -100 totalValue: 56099 cgstValue: 0 sgstValue: 0 igstValue: 300.67 cessValue: 400.56 cessNonAdvolValue: 400 totInvValue: 68358 transporterId: 27AAACQ3770E004 transporterName: '' transDocNo: '' transMode: '1' transDistance: '1000' transDocDate: '' vehicleNo: PVC1234 vehicleType: R itemList: - productName: Wheat productDesc: Wheat hsnCode: 1001 quantity: 4 qtyUnit: BOX cgstRate: 0 sgstRate: 0 igstRate: 3 cessRate: 3 cessNonadvol: 0 taxableAmount: 5609889 summary: 200 EWB generated with alert 604 Duplicate EWB: value: supplyType: O subSupplyType: '1' subSupplyDesc: '' docType: INV docNo: 7001-8 docDate: 15/12/2017 fromGstin: 29AAACQ3770E000 fromTrdName: welton fromAddr1: 2ND CROSS NO 59 19 A fromAddr2: GROUND FLOOR OSBORNE ROAD fromPlace: FRAZER TOWN fromPincode: 400027 actFromStateCode: 27 fromStateCode: 27 toGstin: 27AAACQ3770E000 toTrdName: sthuthya toAddr1: Shree Nilaya toAddr2: Dasarahosahalli toPlace: Beml Nagar toPincode: 560090 actToStateCode: 29 toStateCode: 29 transactionType: 4 otherValue: -100 totalValue: 56099 cgstValue: 0 sgstValue: 0 igstValue: 300.67 cessValue: 400.56 cessNonAdvolValue: 400 totInvValue: 68358 transporterId: 27AAACQ3770E004 transporterName: '' transDocNo: '' transMode: '1' transDistance: '1000' transDocDate: '' vehicleNo: PVC1234 vehicleType: R itemList: - productName: Wheat productDesc: Wheat hsnCode: 1001 quantity: 4 qtyUnit: BOX cgstRate: 0 sgstRate: 0 igstRate: 3 cessRate: 3 cessNonadvol: 0 taxableAmount: 56099 summary: 604 Duplicate EWB 620 Invoice value cannot be less than sum of items: value: supplyType: O subSupplyType: '1' subSupplyDesc: '' docType: INV docNo: 7001-11 docDate: 15/12/2017 fromGstin: 29AAACQ3770E000 fromTrdName: welton fromAddr1: 2ND CROSS NO 59 19 A fromAddr2: GROUND FLOOR OSBORNE ROAD fromPlace: FRAZER TOWN fromPincode: 400027 actFromStateCode: 27 fromStateCode: 27 toGstin: 27AAACQ3770E000 toTrdName: sthuthya toAddr1: Shree Nilaya toAddr2: Dasarahosahalli toPlace: Beml Nagar toPincode: 560090 actToStateCode: 29 toStateCode: 29 transactionType: 4 otherValue: -100 totalValue: 56099 cgstValue: 0 sgstValue: 0 igstValue: 1682.97 cessValue: 1682.97 cessNonAdvolValue: 400 totInvValue: 59464.94 transporterId: 27AAACQ3770E004 transporterName: '' transDocNo: '' transMode: '1' transDistance: '1000' transDocDate: '' vehicleNo: PVC1234 vehicleType: R itemList: - productName: Wheat productDesc: Wheat hsnCode: 1001 quantity: 4 qtyUnit: BOX cgstRate: 0 sgstRate: 0 igstRate: 3 cessRate: 3 cessNonadvol: 0 taxableAmount: 56099 summary: 620 Invoice value cannot be less than sum of items 200 EWB generated: value: supplyType: O subSupplyType: '1' subSupplyDesc: '' docType: INV docNo: 7001-11 docDate: 15/12/2017 fromGstin: 29AAACQ3770E000 fromTrdName: welton fromAddr1: 2ND CROSS NO 59 19 A fromAddr2: GROUND FLOOR OSBORNE ROAD fromPlace: FRAZER TOWN fromPincode: 400027 actFromStateCode: 27 fromStateCode: 27 toGstin: 27AAACQ3770E000 toTrdName: sthuthya toAddr1: Shree Nilaya toAddr2: Dasarahosahalli toPlace: Beml Nagar toPincode: 560090 actToStateCode: 29 toStateCode: 29 transactionType: 4 otherValue: 0 totalValue: 56099 cgstValue: 0 sgstValue: 0 igstValue: 1682.97 cessValue: 1682.97 cessNonAdvolValue: 0 totInvValue: 59464.94 transporterId: 27AAACQ3770E004 transporterName: '' transDocNo: '' transMode: '1' transDistance: '1000' transDocDate: '' vehicleNo: PVC1234 vehicleType: R itemList: - productName: Wheat productDesc: Wheat hsnCode: 1001 quantity: 4 qtyUnit: BOX cgstRate: 0 sgstRate: 0 igstRate: 3 cessRate: 3 cessNonadvol: 0 taxableAmount: 56099 summary: 200 EWB generated 359 User GSTIN should match from GSTIN: value: supplyType: O subSupplyType: '1' subSupplyDesc: '' docType: INV docNo: 7001-20 docDate: 01/05/2024 fromGstin: 27AAACQ3770E004 fromTrdName: welton fromAddr1: 2ND CROSS NO 59 19 A fromAddr2: GROUND FLOOR OSBORNE ROAD fromPlace: FRAZER TOWN fromPincode: 400027 actFromStateCode: 27 fromStateCode: 27 toGstin: 29AAACQ3770E000 toTrdName: sthuthya toAddr1: Shree Nilaya toAddr2: Dasarahosahalli toPlace: Beml Nagar toPincode: 560090 actToStateCode: 29 toStateCode: 29 transactionType: 4 otherValue: 0 totalValue: 56099 cgstValue: 0 sgstValue: 0 igstValue: 1682.97 cessValue: 1682.97 cessNonAdvolValue: 0 totInvValue: 59464.94 transporterId: 24AAACQ3770E003 transporterName: '' transDocNo: '' transMode: '1' transDistance: '1000' transDocDate: '' vehicleNo: PVC1234 vehicleType: R itemList: - productName: Wheat productDesc: Wheat hsnCode: 1001 quantity: 4 qtyUnit: BOX cgstRate: 0 sgstRate: 0 igstRate: 3 cessRate: 3 cessNonadvol: 0 taxableAmount: 56099 summary: 359 User GSTIN should match from GSTIN 619 Transporter Id is mandatory for Part A: value: supplyType: O subSupplyType: '1' subSupplyDesc: '' docType: INV docNo: 7001-100 docDate: 15/12/2017 fromGstin: 27AAACQ3770E004 fromTrdName: welton fromAddr1: 2ND CROSS NO 59 19 A fromAddr2: GROUND FLOOR OSBORNE ROAD fromPlace: FRAZER TOWN fromPincode: 400027 actFromStateCode: 27 fromStateCode: 27 toGstin: 24AAACQ3770E003 toTrdName: sthuthya toAddr1: Shree Nilaya toAddr2: Dasarahosahalli toPlace: Beml Nagar toPincode: 560090 actToStateCode: 29 toStateCode: 29 transactionType: 4 otherValue: 0 totalValue: 56099 cgstValue: 0 sgstValue: 0 igstValue: 1682.97 cessValue: 1682.97 cessNonAdvolValue: 0 totInvValue: 59464.94 transDistance: '0' itemList: - productName: Wheat productDesc: Wheat hsnCode: 1001 quantity: 4 qtyUnit: BOX cgstRate: 0 sgstRate: 0 igstRate: 3 cessRate: 3 cessNonadvol: 0 taxableAmount: 56099 summary: 619 Transporter Id is mandatory for Part A Request Example: value: supplyType: O subSupplyType: '1' subSupplyDesc: '' docType: INV docNo: 7001-11 docDate: 15/12/2017 fromGstin: 29AAACQ3770E000 fromTrdName: welton fromAddr1: 2ND CROSS NO 59 19 A fromAddr2: GROUND FLOOR OSBORNE ROAD fromPlace: FRAZER TOWN fromPincode: 400027 actFromStateCode: 27 fromStateCode: 27 toGstin: 27AAACQ3770E000 toTrdName: sthuthya toAddr1: Shree Nilaya toAddr2: Dasarahosahalli toPlace: Beml Nagar toPincode: 560090 actToStateCode: 29 toStateCode: 29 transactionType: 4 otherValue: 0 totalValue: 56099 cgstValue: 0 sgstValue: 0 igstValue: 1682.97 cessValue: 1682.97 cessNonAdvolValue: 0 totInvValue: 59464.94 transporterId: 27AAACQ3770E004 transporterName: '' transDocNo: '' transMode: '1' transDistance: '1000' transDocDate: '' vehicleNo: PVC1234 vehicleType: R itemList: - productName: Wheat productDesc: Wheat hsnCode: 1001 quantity: 4 qtyUnit: BOX cgstRate: 0 sgstRate: 0 igstRate: 3 cessRate: 3 cessNonadvol: 0 taxableAmount: 56099 summary: Request Example responses: '200': description: >- 212 Invalid Consignee GSTIN / 702 Distance between pincodes is too high or low / 200 EWB generated with alert / 604 Duplicate EWB / 620 Invoice value cannot be less than sum of items / 200 EWB generated / 359 User GSTIN should match from GSTIN / 619 Transporter Id is mandatory for Part A content: application/json: schema: $ref: '#/components/schemas/GenerateEWayBillResponse' examples: 212 Invalid Consignee GSTIN: summary: 212 Invalid Consignee GSTIN value: code: 200 data: error: errorCodes: 212, info: '' status: '0' timestamp: 1763446641000 transaction_id: 52d7e713-2b65-4a8f-9126-16af4e28ec59 702 Distance between pincodes is too high or low: summary: 702 Distance between pincodes is too high or low value: code: 200 data: error: errorCodes: 702, info: >- , The distance between the pincodes given is too high or low status: '0' timestamp: 1763446641000 transaction_id: aa389a61-b231-458e-9838-afa22d92525c 200 EWB generated with alert: summary: 200 EWB generated with alert value: code: 200 data: alert: null data: alert: >- Total invoice value is more than the sum of total assessible value and tax values, ewayBillDate: 01/05/2024 07:00:00 PM ewayBillNo: 291010077005 validUpto: 06/05/2024 11:59:00 PM status: '1' timestamp: 1763446641000 transaction_id: 6021ed55-c0e6-4899-bc08-010e3d276d1f 604 Duplicate EWB: summary: 604 Duplicate EWB value: code: 200 data: error: errorCodes: 604, info: '' status: '0' timestamp: 1763446641000 transaction_id: 6192cf5d-fd97-4447-a8e6-516e49df7135 620 Invoice value cannot be less than sum of items: summary: 620 Invoice value cannot be less than sum of items value: code: 200 data: error: errorCodes: '620' info: '' status: '0' timestamp: 1763446641000 transaction_id: bbcfda04-003b-47d7-b7f2-2c5b8585b2f7 200 EWB generated: summary: 200 EWB generated value: code: 200 data: alert: null data: alert: '' ewayBillDate: 01/05/2024 07:04:00 PM ewayBillNo: 201010077008 validUpto: 06/05/2024 11:59:00 PM status: '1' timestamp: 1763446641000 transaction_id: 36c013cf-1fc3-4f4e-80e9-bd30ed519375 359 User GSTIN should match from GSTIN: summary: 359 User GSTIN should match from GSTIN value: code: 200 data: error: errorCodes: '359' info: '' status: '0' timestamp: 1763446641000 transaction_id: 826d7771-ea56-4419-852e-ff419b5e94bd 619 Transporter Id is mandatory for Part A: summary: 619 Transporter Id is mandatory for Part A value: code: 200 data: error: errorCodes: 619, info: '' status: '0' timestamp: 1763446641000 transaction_id: 00833a69-bea8-41d0-be40-ba5bd63b5ff0 headers: {} deprecated: false security: [] components: schemas: GenerateEWayBillRequest: type: object properties: supplyType: type: string maxLength: 1 minLength: 1 enum: - O - I description: Supply Type subSupplyType: type: string description: Sub Supply Type subSupplyDesc: type: string maxLength: 20 description: Other Sub Supply Description docType: type: string enum: - INV - CHL - BIL - BOE - OTH description: Document Type docNo: type: string maxLength: 16 description: Document Number (Alphanumeric with / and - are allowed) docDate: type: string pattern: '[0-3][0-9]/[0-1][0-9]/[2][0][1-2][0-9]' description: Document Date fromGstin: type: string maxLength: 15 pattern: ^[0-9]{2}[0-9A-Z]{13}$|^URP$|^urp$ description: From GSTIN (Supplier or Consignor) fromTrdName: type: string maxLength: 100 description: From Trade Name (Consignor Trade name) fromAddr1: type: string maxLength: 120 description: 'From Address Line 1 (Valid Special Chars #,-,/)' fromAddr2: type: string maxLength: 120 description: 'From Address Line 2(Valid Special Chars # , - ,/)' fromPlace: type: string maxLength: 50 description: From Place actFromStateCode: type: integer maximum: 99 description: Actual From State Code fromPincode: type: integer maximum: 999999 minimum: 100000 description: From Pincode fromStateCode: type: integer maximum: 99 description: From State Code toGstin: type: string maxLength: 15 pattern: ^[0-9]{2}[0-9A-Z]{13}$|^URP$|^urp$ description: To GSTIN (Consignee or Recipient) toTrdName: type: string maxLength: 100 description: To Trade Name (Consignee Trade name or Recipient Trade name) toAddr1: type: string maxLength: 120 description: 'To Address Line 1 (Valid Special Chars #,-,/)' toAddr2: type: string maxLength: 120 description: 'To Address Line 2 (Valid Special Chars #,-,/)' toPlace: type: string maxLength: 50 description: To Place toPincode: type: integer description: To Pincode actToStateCode: type: integer maximum: 99 description: Actual To State Code toStateCode: type: integer maximum: 99 description: To State Code transactionType: type: integer maximum: 4 description: Transaction type totalValue: type: number multipleOf: 0.01 description: 'Sum of Taxable value ' cgstValue: type: number multipleOf: 0.01 description: CGST value sgstValue: type: number multipleOf: 0.01 description: SGST value igstValue: type: number multipleOf: 0.01 description: IGST value cessValue: type: number multipleOf: 0.01 description: Cess value cessNonAdvolValue: type: number multipleOf: 0.01 description: Cess Non Advol value otherValue: type: number multipleOf: 0.01 description: 'Other charges, if any ' totInvValue: type: number multipleOf: 0.01 description: >- Total Invoice Value (Including taxable value, tax value,and other charges if any) transMode: type: string enum: - '1' - '2' - '3' - '4' description: 'Mode of transport (Road-1, Rail-2, Air-3, Ship-4) ' transDistance: type: string description: 'Distance (<4000 km) ' transporterName: type: string maxLength: 100 description: Name of the transporter transporterId: type: string pattern: '[0-9]{2}[0-9|A-Z]{13}' description: 15 Digit Transporter GSTIN/TRANSIN transDocNo: type: string maxLength: 15 description: Transport Document Number (Alphanumeric with / and – are allowed) transDocDate: type: string description: Transport Document Date vehicleNo: type: string minLength: 7 maxLength: 15 description: Vehicle Number vehicleType: type: string description: Vehicle Type itemList: type: array items: type: object properties: productName: type: string maxLength: 100 description: Product / Item Name productDesc: type: string maxLength: 100 description: Product / Item description hsnCode: type: number description: HSN Code quantity: type: number description: Quantity qtyUnit: type: string maxLength: 3 minLength: 3 description: Unit taxableAmount: type: number multipleOf: 0.01 description: Taxable Amount sgstRate: type: number multipleOf: 0.001 description: SGST Rate of Tax cgstRate: type: number multipleOf: 0.001 description: CGST Rate of Tax igstRate: type: number multipleOf: 0.001 description: IGST Rate of Tax cessRate: type: number multipleOf: 0.001 description: Cess Rate of Tax cessNonadvol: type: number description: Cess Non-Advolerum required: - hsnCode - taxableAmount description: The itemList value. required: - supplyType - subSupplyType - docType - docNo - docDate - fromGstin - fromPincode - fromStateCode - toGstin - toPincode - toStateCode - transDistance - itemList - actToStateCode - actFromStateCode - totInvValue - transactionType description: E-Way Bill schema. GenerateEWayBillResponse: oneOf: - $ref: '#/components/schemas/GenerateEWayBillSuccessResponse' - $ref: '#/components/schemas/EWayBillBusinessErrorResponse' description: >- An E-Way Bill success or NIC business-failure response. Both variants use HTTP 200. GenerateEWayBillSuccessResponse: allOf: - $ref: '#/components/schemas/EWayBillResponseMetadata' - type: object required: - data properties: data: type: object properties: alert: type: string nullable: true example: null data: $ref: '#/components/schemas/GenerateEWayBillSuccessPayload' error: type: object properties: errorCodes: type: string example: 212, info: type: string example: '' status: type: string example: '0' enum: - '1' description: NIC success status. EWayBillBusinessErrorResponse: allOf: - $ref: '#/components/schemas/EWayBillResponseMetadata' - type: object required: - data properties: data: type: object required: - status - error properties: status: type: string enum: - '0' description: NIC sends "0" when it rejects a request. error: $ref: '#/components/schemas/EWayBillBusinessError' EWayBillResponseMetadata: type: object description: Metadata returned with every E-Way Bill response. required: - code - timestamp - transaction_id properties: code: type: integer enum: - 200 description: NIC response code. timestamp: type: integer format: int64 description: Unix timestamp. transaction_id: type: string description: Request transaction identifier. GenerateEWayBillSuccessPayload: type: object properties: alert: type: string example: >- Total invoice value is more than the sum of total assessible value and tax values, description: The alert value. ewayBillDate: type: string example: 01/05/2024 07:00:00 PM description: The ewayBillDate value. ewayBillNo: type: number example: 291010077005 description: The ewayBillNo value. validUpto: type: string example: 06/05/2024 11:59:00 PM description: The validUpto value. description: E-Way Bill schema. EWayBillBusinessError: type: object description: Error data from NIC. required: - errorCodes properties: errorCodes: type: string description: >- NIC error code. See [E-Way Bill error codes](/api-reference/gst/annexures/e-way-bill-error-codes). ````