Task #94
Updated by Rajesh Gotur 3 days ago
------------------------------------------------------------------------
# E-Way Bill Creation User Manual
------------------------------------------------------------------------
## 1. Story Title
**Create a Comprehensive User Manual for E-Way Bill Creation**
------------------------------------------------------------------------
## 2. Story Description
Created a detailed **E-Way Bill User Manual** to document the complete
E-Way Bill creation process implemented in the application.
The manual was prepared to provide users with a clear and structured
procedure for creating E-Way Bill Requests, validating the entered
information, fetching item details, generating the E-Way Bill through
the E-Way Bill API, and reviewing the generated E-Way Bill Number and
PDF.
The documentation covers **two supported E-Way Bill creation methods**:
1. **Create E-Way Bill Using an E-Way Bill Request Template**
2. **Create E-Way Bill Directly Without Using a Template**
The manual explains the purpose of each method, the fields that must be
entered or verified, mandatory information, validation steps, API-based
generation, expected document status changes, and the final E-Way Bill
PDF output.
The objective was to make the complete workflow understandable to both
users familiar with the application and users performing the process for
the first time.
------------------------------------------------------------------------
# 3. Documentation Objective
The primary objective of the user manual is to provide a standardized
reference for the E-Way Bill creation workflow.
The documentation ensures that users can understand:
``` text
How to create the request
↓
How to provide the required details
↓
How to use a saved template
↓
How to create a request without a template
↓
How to fetch item details
↓
How to validate the request
↓
How to resolve validation errors
↓
How to generate the E-Way Bill
↓
How to verify the E-Way Bill Number
↓
How to review the generated PDF
```
The manual specifically emphasizes that information must be reviewed
before saving and before generating the E-Way Bill.
------------------------------------------------------------------------
# 4. Scope of the User Manual
The manual documents the following areas:
- E-Way Bill Request Template creation.
- E-Way Bill Request creation using a saved template.
- Direct E-Way Bill Request creation without a template.
- Request and company details.
- Billing party details.
- Shipping party details.
- Transporter information.
- Part-B transportation details.
- Import document information where applicable.
- HSN consolidation option.
- Invoice/tax totals verification.
- Mandatory-field verification.
- Item fetching.
- E-Way Bill Request validation.
- Error correction and re-validation.
- E-Way Bill generation.
- API submission flow.
- E-Way Bill Number verification.
- Generated E-Way Bill PDF review.
- Sample E-Way Bill PDF reference.
------------------------------------------------------------------------
# 5. High-Level Workflow
``` text
E-WAY BILL CREATION
│
┌────────────────┴────────────────┐
│ │
▼ ▼
METHOD 1 — TEMPLATE METHOD 2 — DIRECT
│ │
▼ ▼
Create Template Create Request
│ │
▼ │
Save Template Leave Template Empty
│ │
└────────────────┬────────────────┘
▼
Enter / Verify Details
│
▼
Save Request
│
▼
Fetch Items
│
▼
Verify Item Details
│
▼
Validate E-Way Bill
│
┌────────┴────────┐
│ │
Error Valid
│ │
▼ ▼
Correct Data Generate E-Way Bill
│ │
└── Revalidate ▼
API Submission
│
▼
E-Way Bill Number
│
▼
E-Way Bill PDF
```
------------------------------------------------------------------------
# 6. Method 1 --- Create E-Way Bill Using a Template
The first documented method uses an **E-Way Bill Request Template**.
A saved template allows commonly used information to be automatically
populated when creating a new E-Way Bill Request. This reduces
repetitive data entry and improves consistency.
The manual explains that users must still verify automatically populated
information before continuing.
------------------------------------------------------------------------
## 6.1 Create an E-Way Bill Request Template
The user manual documents the following process:
1. Open the application menu.
2. Search for **E-Way Bill Request Template**.
3. Open the E-Way Bill Request Template list.
4. Click **+ Add E-Way Bill Request Template**.
5. Enter the required template information.
6. Review all entered information.
7. Save the template.
The manual specifically warns users to verify the information because
template values may later be carried into E-Way Bill Requests.
------------------------------------------------------------------------
# 7. Template Details Documented
The manual explains the purpose of the major template fields.
### Template Name
A unique and meaningful name is entered so that the template can be
easily identified later.
### Company
The company for which the E-Way Bill will be created is selected.
### Company Address
The appropriate company address associated with the selected company is
selected.
### Requestor Type
The user selects the party requesting the E-Way Bill:
- Tax Payer
- Transporter
### Supply Type
The direction of supply is selected:
- Outward
- Inward
### Sub Type
The reason/nature of movement is selected, including options such as:
- Supply
- Import
- Export
- Job Work
- For Own Use
- Sales Return
- Others
### Transaction Type
The manual explains the available billing/dispatch combinations:
- Regular
- Bill To -- Ship To
- Bill From -- Dispatch From
- Combination
### Document Type
The supporting document type is selected, such as:
- Tax Invoice
- Bill of Supply
- Bill of Entry
- Delivery Challan
- Others
### Consolidate Items by HSN
This option is enabled where items need to be consolidated based on HSN.
These template fields and their purposes are documented in the supplied
manual. fileciteturn21file9L498-L551
------------------------------------------------------------------------
# 8. Billing Parties Information
The manual documents the billing-party section:
``` text
Bill From
Bill From Address
Bill To
Bill To Address
```
### Bill From
The supplier/party from whom the goods are billed is selected.
### Bill From Address
The appropriate billing address of the Bill From party is selected.
### Bill To
The customer/recipient to whom the goods are billed is selected.
### Bill To Address
The appropriate billing address of the Bill To party is selected.
The manual emphasizes that these details must correspond correctly to
the relevant business partners. fileciteturn21file7L332-L342
------------------------------------------------------------------------
# 9. Shipping Parties Information
The shipping section documents the physical movement of the goods:
``` text
Dispatch From
Dispatch From Address
Ship To
Ship To Address
```
The manual distinguishes the physical dispatch/delivery locations from
the billing parties, which is important for transactions where billing
and physical movement involve different parties.
------------------------------------------------------------------------
# 10. Transporter and Part-B Information
The manual documents transportation-related fields including:
``` text
Transporter
Transporter Name
Approximate Distance
Transporter Mode
Vehicle Number
Vehicle Type
Transport Receipt No
Transport Receipt Date
```
Transport modes include:
- Road
- Rail
- Air
- Ship
- In Transit
Vehicle type includes:
- Regular
- Over Dimensional Cargo (ODC)
These fields are documented as part of the transportation and Part-B
workflow. fileciteturn20file9L632-L653
------------------------------------------------------------------------
# 11. Save and Verify the Template
After all template details are entered:
1. Review all information.
2. Verify company information.
3. Verify supply and transaction details.
4. Verify billing parties.
5. Verify shipping parties.
6. Verify transporter details.
7. Verify distance and transportation mode.
8. Verify vehicle type.
9. Correct any missing or incorrect information.
10. Click **Save**.
The saved template can subsequently be selected during E-Way Bill
Request creation.
The manual explicitly notes that incorrect template data can be carried
forward into future requests, making verification an important part of
the documented workflow. fileciteturn20file9L654-L664
------------------------------------------------------------------------
# 12. Method 1 --- Create E-Way Bill Using Saved Template
After the template has been created:
1. Search for **E-Way Bill Request List**.
2. Open the list.
3. Click **+ New E-Way Bill Request**.
4. Locate the **E-Way Bill Request Template** field.
5. Open the template dropdown.
6. Select the required saved template.
7. Allow the saved template information to populate the request.
The manual emphasizes that automatic population does not eliminate the
need for verification. fileciteturn21file7L302-L316
------------------------------------------------------------------------
# 13. Verify Automatically Populated Information
After selecting the template, the following sections are reviewed:
### Request and Company Details
- Requestor Type
- Company
- Company Address
- GSTIN
- Supply Type
- Sub Type
- Document Type
- Transaction Type
- Import Document Type, where applicable
- Import Document Name, where applicable
- Consolidate Items by HSN, where applicable
### Billing Information
- Bill From
- Bill From Address
- Bill To
- Bill To Address
### Shipping Information
- Dispatch From
- Dispatch From Address
- Ship To
- Ship To Address
### Transporter Information
- Transporter
- Transporter Name
- Approximate Distance
### Part-B Information
- Transporter Mode
- Vehicle Number
- Vehicle Type
- Transport Receipt Number
- Transport Receipt Date
The complete verification sequence is documented in the manual.
fileciteturn21file8L415-L453
------------------------------------------------------------------------
# 14. Verify Totals
The manual also documents verification of the invoice/tax totals:
``` text
CGST Amount
SGST Amount
IGST Amount
CESS Advol Amount
CESS Non-Advol Amount
Total Taxable Value
Other Amount
Total Invoice Amount
```
The totals must be checked against the applicable invoice/document
before the request is saved. fileciteturn21file7L356-L367
------------------------------------------------------------------------
# 15. Mandatory Fields
The manual identifies the following mandatory fields:
``` text
Bill From GSTIN
Bill From State
Bill To GSTIN
Bill To State
```
These fields must be correctly populated before proceeding with the
request. fileciteturn21file7L368-L373
------------------------------------------------------------------------
# 16. Import Document Selection
Where applicable, the manual instructs users to select the appropriate
**Bill of Entry** from the **Import Document Name** field.
Process:
1. Open the Import Document Name field.
2. Select the appropriate Bill of Entry.
3. Verify the Bill of Entry number.
4. Confirm that it corresponds to the transaction.
5. Continue with the request process.
The selected Bill of Entry is used for fetching the relevant item
details. fileciteturn21file7L374-L380
------------------------------------------------------------------------
# 17. Bill From and Bill To Address Verification
The manual specifically highlights address verification.
### Bill From Address
Must correspond to the selected Bill From party.
### Bill To Address
Must correspond to the selected Bill To party.
Both addresses must be reviewed before saving the E-Way Bill Request.
fileciteturn21file7L381-L386
------------------------------------------------------------------------
# 18. Save and Fetch Items
Once all information is verified:
``` text
Save
↓
Confirm Saved Status
↓
Fetch Items
↓
Review Fetched Items
```
The manual instructs users to perform **Fetch Items only after the
request has been saved**.
This ensures that the request is in the appropriate state before item
information is retrieved.
------------------------------------------------------------------------
# 19. Validate E-Way Bill Request
After the item details are fetched:
1. Review all item details.
2. Click **Validate E-Way Bill Request**.
3. If validation succeeds, continue to E-Way Bill generation.
4. If validation fails, review the error.
5. Correct the relevant information.
6. Validate the request again.
The manual explains that validation errors must be resolved before the
E-Way Bill is generated. fileciteturn21file4L241-L249
------------------------------------------------------------------------
# 20. Error Handling and Re-Validation
The documented validation flow is:
``` text
Validate Request
│
▼
Valid?
/ \
No Yes
│ │
▼ ▼
Review Generate
Error E-Way Bill
│
▼
Correct Data
│
▼
Validate Again
```
If an error occurs, the document status changes to **Error**.
The user must correct the relevant information and run validation again.
The manual also documents the appearance of a **Cancel** option after
successful validation, allowing a validated request to be cancelled if
required. fileciteturn21file4L241-L248
------------------------------------------------------------------------
# 21. Generate E-Way Bill
Once the request has been successfully validated:
1. The **Generate E-Way Bill** button becomes available.
2. Click **Generate E-Way Bill**.
3. The system calls the E-Way Bill API.
4. The request is submitted to the E-Way Bill Portal.
5. After successful generation, the E-Way Bill Number and PDF become
available in the Preview section.
The manual specifically instructs users to generate the E-Way Bill only
after successful validation. fileciteturn21file0L11-L19
------------------------------------------------------------------------
# 22. API Integration Flow
The user manual documents the external integration at a functional
level:
``` text
Application
│
▼
Generate E-Way Bill
│
▼
E-Way Bill API
│
▼
E-Way Bill Portal
│
▼
Successful Generation
│
├── E-Way Bill Number
│
└── E-Way Bill PDF
```
The manual therefore provides users with an understanding of what
happens after the **Generate E-Way Bill** action.
------------------------------------------------------------------------
# 23. Preview and Final Verification
After successful generation:
1. Open the **Preview** tab.
2. Scroll to the **E-Way Bill Details** section.
3. Verify the generated E-Way Bill Number.
4. Review the generated E-Way Bill PDF.
5. Confirm that the generated document corresponds to the request.
This provides a final verification point after the API-based generation
process. fileciteturn21file0L13-L19
------------------------------------------------------------------------
# 24. Method 2 --- Direct E-Way Bill Creation
The second documented method allows users to create an E-Way Bill
Request **without using an E-Way Bill Request Template**.
This method is useful when the request-specific information changes and
a reusable template is not appropriate.
Unlike Method 1, the user must manually enter and verify the required
information.
------------------------------------------------------------------------
# 25. Method 2 --- Create New E-Way Bill Request
The documented steps are:
1. Search for **E-Way Bill Request List**.
2. Open the list.
3. Click **+ New E-Way Bill Request**.
This starts a new request directly without selecting a saved template.
fileciteturn21file6L283-L289
------------------------------------------------------------------------
# 26. Template Field Must Remain Empty
For Method 2:
``` text
E-Way Bill Request Template = EMPTY
```
The manual explicitly instructs the user not to select a template from
the dropdown.
Because no template is being used, all required information must be
entered manually. fileciteturn20file6L403-L413
------------------------------------------------------------------------
# 27. Method 2 --- Required Details
The manual documents the same major information groups for direct entry.
### Request and Company
- Requestor Type
- Company
- Company Address
- GSTIN
- Supply Type
- Sub Type
- Document Type
- Transaction Type
- Import Document Type, where applicable
- Import Document Name, where applicable
- Consolidate Items by HSN, where applicable
### Billing
- Bill From
- Bill From Address
- Bill To
- Bill To Address
### Shipping
- Dispatch From
- Dispatch From Address
- Ship To
- Ship To Address
### Transport
- Transporter
- Transporter Name
- Approximate Distance
### Part-B
- Transporter Mode
- Vehicle Number
- Vehicle Type
- Transport Receipt Number
- Transport Receipt Date
These details are documented as mandatory workflow inputs depending on
the transaction. fileciteturn21file2L72-L114
------------------------------------------------------------------------
# 28. Method 2 --- Manual Verification
Because no template is used, the user must manually verify:
``` text
Company and GSTIN
Supply and transaction details
Bill From / Bill To
Bill From / Bill To addresses
Dispatch From / Ship To
Transporter details
Transport mode
Vehicle details
Import document details
```
Mandatory fields include:
``` text
Bill From GSTIN
Bill From State
Bill To GSTIN
Bill To State
```
This verification requirement is explicitly documented in the manual.
fileciteturn21file2L115-L130
------------------------------------------------------------------------
# 29. Method 2 --- Save, Fetch, Validate and Generate
The direct workflow is:
``` text
Enter Details
↓
Verify Details
↓
Save
↓
Confirm Saved Status
↓
Fetch Items
↓
Verify Items
↓
Validate E-Way Bill Request
↓
Resolve Errors if Any
↓
Validate Again
↓
Generate E-Way Bill
↓
Submit / Complete Generation
↓
Review E-Way Bill Number and PDF
```
The manual explicitly states that the template field must remain empty
throughout this direct-creation process.
fileciteturn20file8L573-L584
------------------------------------------------------------------------
# 30. Sample E-Way Bill PDF
The user manual includes a **Sample E-Way Bill PDF** section.
The sample is provided as a visual reference so users can understand:
- Generated document layout.
- E-Way Bill information.
- Key fields shown in the generated document.
- Expected PDF format.
The manual instructs users to use the sample PDF as a reference for
understanding the generated output. fileciteturn21file2L143-L145
------------------------------------------------------------------------
# 31. Documentation Design Approach
The manual was structured to make the process easy to follow.
The documentation approach includes:
### Step-Based Instructions
Each workflow is divided into numbered steps.
### Field-Level Explanation
Important fields are explained individually rather than listing only
field names.
### Important Notes
Critical validation requirements are explicitly highlighted.
### Two Separate Workflows
Template-based and direct creation are documented independently to avoid
confusion.
### Verification Points
The manual identifies where users must verify information before moving
to the next stage.
### Final Output Reference
The generated E-Way Bill Number and PDF are documented as the final
output.
------------------------------------------------------------------------
# 32. Key User Safeguards Documented
The manual emphasizes the following safeguards:
``` text
Verify template information before saving
↓
Verify automatically populated information
↓
Verify Bill From / Bill To addresses
↓
Verify mandatory GSTIN and State fields
↓
Verify totals
↓
Save request
↓
Fetch items
↓
Review items
↓
Validate request
↓
Resolve all errors
↓
Generate E-Way Bill
↓
Verify E-Way Bill Number and PDF
```
These checkpoints reduce the possibility of generating an E-Way Bill
with incorrect information.
------------------------------------------------------------------------
# 33. Documentation Deliverable
The completed documentation deliverable is:
``` text
E-WAY-BILL-USER-MANUAL.docx
```
The document provides the operational instructions required for users to
complete the E-Way Bill creation process.
------------------------------------------------------------------------
# 34. Jira Acceptance Criteria
- [x] E-Way Bill creation workflow documented.
- [x] E-Way Bill Request Template creation documented.
- [x] Template field explanations documented.
- [x] Billing-party information documented.
- [x] Shipping-party information documented.
- [x] Transporter and Part-B details documented.
- [x] Saved-template E-Way Bill creation documented.
- [x] Automatically populated fields and their verification
documented.
- [x] Totals verification documented.
- [x] Mandatory fields documented.
- [x] Import document selection documented where applicable.
- [x] Save and Fetch Items sequence documented.
- [x] E-Way Bill Request validation documented.
- [x] Validation error handling documented.
- [x] Re-validation process documented.
- [x] E-Way Bill API generation flow documented.
- [x] Preview tab and E-Way Bill Number verification documented.
- [x] Generated E-Way Bill PDF review documented.
- [x] Direct E-Way Bill creation without template documented.
- [x] Requirement to leave the template field empty in Method 2
documented.
- [x] Sample E-Way Bill PDF included as a reference.
------------------------------------------------------------------------
# 35. Final Jira Story Summary
### **Title**
**Create Comprehensive E-Way Bill Creation User Manual**
### **Description**
Created a comprehensive user manual for the application's E-Way Bill
creation workflow. The documentation covers both supported creation
methods: creating an E-Way Bill using a saved E-Way Bill Request
Template and creating an E-Way Bill Request directly without a template.
The manual provides step-by-step instructions for creating templates,
entering and verifying company, billing, shipping, transporter, Part-B,
import-document and transaction information, validating mandatory
fields, saving requests, fetching item details, handling validation
errors, and re-validating requests.
The documentation also explains the final E-Way Bill generation process,
including the API submission to the E-Way Bill Portal, availability of
the generated E-Way Bill Number and PDF in the Preview section, and
final verification of the generated document.
A dedicated direct-creation workflow is documented to clarify that the
**E-Way Bill Request Template field must remain empty** when Method 2 is
used. The manual also includes a sample E-Way Bill PDF as a reference
for the expected generated output.
The completed documentation provides a standardized operational
reference for users and establishes a clear, repeatable process for
E-Way Bill creation.