xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField SalesCRMRewardsClaimsInventoryProcurementWarehouse ManagementField ServiceServiceSupportTelephony & MessagingFinance & AccountingPayrollExpense ManagementCommercePortalsAnalytics & ReportingData StudioMobile AppSee all products →
PLATFORM
Platform overviewApp BuilderAutomationIntegrationsSecurity & GovernanceChange ManagementDevelopers
SENSE AI
Sense AI overviewSense AssistSense ControlSense VisionAI StudioTrust & governanceIn Claude & ChatGPTUse cases
SOLUTIONS
FMCG & DistributionManufacturing & Dealer NetworksAutomotive & DealershipsPharma & HealthcareConsumer DurablesAgri-InputsBuilding MaterialsService NetworksWarehousing & 3PLFinancial AccountingERP SoftwareIndia GST ComplianceUAE VAT & e-InvoicingSaudi ZATCA & VATAll solutions →
RESOURCES
Knowledge CenterDeveloper & CLIBlogGuidesWhat is xMatix?Company facts
COMPANY
AboutCareersPartnersEventsContactAuthorsLegal
Sign in Request demo
Home/Docs/Entity Reference/E-Way Bill — entity reference
REFERENCE · Last reviewed

E-Way Bill — entity reference

An e-way bill (Rule 138) for a movement of goods - one register entry per generated bill, linked polymorphically to its source document via SourceEntityName/SourceRecordId (invoice, delivery order, transfer) and to the GSTRegistration, branch and company it was generated under. Created as Draft with its Part A consignment payload built from the source document; when the NIC/GSP generation result arrives the EWB number, generated date, Part B transport payload and raw response are recorded and validity is computed by the NIC rule of one day per 200 km or part thereof (minimum one day). Status runs Draft, Generated, Cancelled, Expired; the service also lists the register per company/GSTIN/date range and surfaces bills expiring within a window for expiry alerts. Portal transport happens through the connector integration, not through this record.

Fields

FieldLabelTypeRequiredWhat it does
BranchIdBranchLookup → Branch
ChallanTypeChallan TypeTextReturnable or Non-Returnable - the delivery-challan classification carried into the Part A payload for challan-based movements (job work, stock transfer) rather than tax-invoice movements.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DistanceKmDistance KmNumber
DocumentDateDocument DateDate
DocumentNumberDocument NumberText
DocumentTypeDocument TypeText
EwbNumberEwb NumberText
GeneratedDateGenerated DateDate
GspResponseGsp ResponseText
GSTRegistrationIdGST RegistrationLookup → GSTRegistration
IdIdGuidYes
LabelLabelText
ModifiedByIdModified ByLookup → UserAccountYes
NameNameText, uniqueYes
OwnerIdOwnerLookup → UserAccountYes
PartAPayloadPartA PayloadTextThe Part A consignment JSON built at creation (supply type, document type/number/date, total invoice value, transport distance, challan type) - the payload half describing WHAT moves; Part B (PartBPayload) carries the transport details and is recorded with the generation result.
PartBPayloadPartB PayloadText
PartnerAccountIdPartner AccountLookup → Account
RecordTypeIdRecord TypeGuid, hidden
SourceEntityNameSource Entity NameTextPolymorphic source-document pointer (with SourceRecordId): the entity name of the document the bill covers, such as an invoice, delivery order or transfer.
SourceRecordIdSource RecordGuid
StatusStatusTextLifecycle: Draft (register entry created with Part A payload), Generated (EWB number recorded, validity computed), Cancelled, Expired. Expiry alerts scan Generated bills whose ValidUpto falls within the warning window.
SubSupplyTypeSub Supply TypeText
SupplyTypeSupply TypeText
TotalValueTotal ValueCurrency
TransporterIdTransporterText
TransporterNameTransporter NameText
TransportModeTransport ModeText
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes
ValidUptoVal UptoDateValidity end computed at generation from the NIC rule: one day per 200 km of transport distance or part thereof, minimum one day, counted from the generation date.
VehicleNumberVehicle NumberText

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete the selected records.
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete in a list page
EditEditEditEdit
EditInLineEditEditInlineEditInLine
EditListRowEditEditEditListRow
NewNewNewNew