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/Visit Route Group — entity reference
REFERENCE · Last reviewed

Visit Route Group — entity reference

A container grouping related VisitRoutes and their VisitPlans, carrying shared context (branchId, partnerAccountId, visitPurpose, visitTaskTemplateId, resourceId). It is the host of territory planning: the PlanTerritory action splits a set of accounts across executives and creates one VisitRoute per executive under this group, sequenced over real road times.

Fields

FieldLabelTypeRequiredWhat it does
BranchIdBranchLookup → Branch
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
IdIdGuidYes
ModifiedByIdModified ByLookup → UserAccountYes
NameNameText
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountIdPartner AccountLookup → Account
RecordTypeIdRecord TypeGuid, hidden
ResourceIdResourceLookup → Resource
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes
VisitPurposeVisit PurposePickListValues: Order Delivery, Product Demo, Order Capture, Ready Stock Sales, Van Sales.
VisitRouteCodeVisit Route CodeText
VisitTaskTemplateIdVisit Task TemplateLookup → VisitTaskTemplate

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete the selected records.
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete in a list page
EditEditEditEdit
EditInLineEditEditEdit in page.
EditInListEditEditInlineEdit In List Header
NewNewNewNew
PlanTerritoryPlan TerritoryServerAction (PlanTerritory, async)Multi-executive territory planning (vehicle-routing solve): splits a set of accounts across the given executives or seats and sequences each route over real road travel times, persisting one VisitRoute per executive under this group (stops in solver order) plus a RouteSequence audit run each. Args: executiveResourceIds[] or positionIds[] (positions win and stamp seat ownership), accountIds[] or accountGroupId or partnerAccountId, travelMode, maxStopsPerRoute, replaceExisting (default true). Requires the road-matrix provider; marked async it runs on the background worker at any size, while a synchronous invocation is capped to a small account count so the chunked matrix fits the request budget. The result reports per-route load, dropped and un-geocoded accounts, and deactivated prior routes.