GSTZen has introduced updated payload validations for E-Way Bill API requests to check whether the request meets the published rules of the Government E-Way Bill System before forwarding it to the portal.
These validations help identify missing or invalid fields, provide clear error messages, and reduce unnecessary API requests to the government portal.
What Has Changed?
Previously, only limited validations were performed before sending API requests to the government portal. With the updated validations, GSTZen checks the request against the documented E-Way Bill API rules and master codes before forwarding it.
The updated validations help users:
- Identify invalid or missing fields before the request reaches the portal.
- View multiple validation errors in a single response.
- Correct payload errors more easily.
- Avoid unnecessary portal requests for invalid payloads.
What we checked before (per API)
| API action | Checks before the change |
| All actions | Body is valid JSON; body is not empty |
| generate | Nothing beyond the above. All fields went to the portal unchecked |
| getewb | ewbNo is present |
| get-consolidated | tripSheetNo is present |
| cancel | ewbNo present; cancelRsnCode present |
| closure | ewbNo present; closureDate present and is a readable date; remarks present |
| consolidate | tripSheetEwbBills is a non-empty list; each entry has an ewbNo |
| update-partb , extend , update-transporter , initiate-multivehicle-movement , add-multi-vehicles , change-multi-vehicles | ewbNo present. Nothing else |
| Transporter reports (get by date / state / generator GSTIN) | The required query parameter is present |
What we check now (per API)
Generate E-Way Bill
The following details are validated when generating an E-Way Bill:
- Supply and Sub-Supply Type: The supply type and sub-supply type must be valid combinations.
- Document Details: Document type, document number and document date must follow the applicable validation rules.
- GSTIN Details: Supplier GSTIN, recipient GSTIN and transporter ID must follow the applicable format requirements.
- Address Details: PIN codes, state codes, names and addresses must meet the specified validation requirements.
- Transport Details: Transport mode, vehicle number, transport document number and document date must be provided as required for the selected transport mode.
- Distance: The distance must be a valid whole number within the applicable limits.
- Invoice Details: Taxable value, tax amounts, other charges and total invoice value must satisfy the applicable validation rules.
- Item Details: At least one valid goods item must be provided, with the required HSN, description, quantity, unit and taxable amount.
- Tax Details: GST rates and the applicable CGST, SGST and IGST values must be consistent with the transaction.
Update Part-B / Vehicle Details
When updating Part-B details, the request is validated for:
- Valid E-Way Bill number.
- From-place and state details.
- Valid reason code and remarks.
- Transport mode and the applicable vehicle or transport document details.
Cancel E-Way Bill
The cancellation request must contain a valid 12-digit E-Way Bill number and a valid cancellation reason code.
The supported reason codes are:
- 1 – Duplicate
- 2 – Order Cancelled
- 3 – Data Entry Mistake
- 4 – Others
Extend E-Way Bill Validity
The extension request is validated for:
- Valid E-Way Bill number.
- From-place, state and PIN code details.
- Remaining distance within the applicable limits.
- Valid extension reason and remarks.
- Transport mode and the required vehicle, document or transit details.
Update Transporter Details
The transporter update request must contain a valid transporter GSTIN or TRANSIN, as applicable.
Generate Consolidated E-Way Bill
The request must contain valid from-place, state and transport mode details, along with at least one valid E-Way Bill number.
Multi-Vehicle Movement
For multi-vehicle movement requests, the required reason, remarks, from-place and to-place details must be provided. The request is also validated for quantity, unit, group number and vehicle or transport document details.
Close E-Way Bill
The closure request must contain a valid 12-digit E-Way Bill number, a valid closure date that is not in the future, and the required remarks.
Get E-Way Bill and Transporter Reports
Read and report API requests are validated for the required E-Way Bill number, consolidated E-Way Bill number, date, state and GSTIN fields, depending on the API action.
What Has Not Changed?
The existing checks and restrictions continue to apply, including:
- Subscription and account eligibility checks.
- Recipient GSTIN block checks during E-Way Bill generation.
- Restrictions on modifying E-Way Bills that have not been generated, have been cancelled or rejected, or are no longer valid.
The updated validations are intended to align with the published government API rules and do not introduce new compliance requirements.
Validations Performed by the Government Portal
Some validations are still performed by the government portal. These include:
- Actual GSTIN registration and active status.
- E-Way Bill existence, status and validity.
- PIN-to-PIN distance rules.
- Government portal time limits, such as the applicable E-Way Bill cancellation window.
GSTZen’s local validation checks the GSTIN format and checksum; it does not replace the government’s registration-status verification.
Impact on GSTZen API Users
The updated validations help ERP and API users identify payload issues before requests are sent to the government portal. Users receive clearer error messages, can correct invalid fields more efficiently, and can reduce unnecessary portal requests.
If a request that meets the documented validation rules is still rejected, please share the API request and response with the GSTZen Support Team for further investigation.
For More detailed Information refer- Click Here