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 Stop — entity reference
REFERENCE · Last reviewed

Visit Route Stop — entity reference

One outlet's membership on a beat: visitRouteId plus accountId, with per-stop day availability, time window, task template override and coordinates (accountLocation). Each stop becomes one Visit when a plan of the route is generated. Membership state lives in status: stops proposed from the mobile nearby-onboarding flow are Proposed and generate no visits until approved, and a proposal duplicating an account already on the route (any status) is rejected at save. Stops are moved between beats by repointing visitRouteId (the TransferStops action), never delete+insert, so visit history and the onboarding trail stay attached.

Fields

FieldLabelTypeRequiredWhat it does
AccountIdAccountLookup → Account
AccountLocationAccount LocationGeoLocationThe stop's own coordinates (geography point, wire shape latitude/longitude). Used for sequence optimization and stamped onto generated visits as their assignedLocation; when absent, the account's stored geo-location is used instead.
AllowedGeofencingToleranceAllowed Geofencing Tolerance (KM)NumberPer-stop geofence radius override for check-in at this outlet, distinct from the tolerance carried on the generated visit.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DayNumbersDay NumbersText
DurationDurationCalculated (calculated)
EndTimeEnd TimeTimeOnly
FridayAvailableFriday AvailableBooleanYes
IdIdGuidYes
ModifiedByIdModified ByLookup → UserAccountYes
MondayAvailableMonday AvailableBooleanYes
NameNameText
OwnerIdOwnerLookup → UserAccountYes
RecordTypeIdRecord TypeGuid, hidden
RemarksRemarksText
SaturdayAvailableSaturday AvailableBooleanYes
SequenceNumberSequence NumberNumberThe authored order of the stop on the beat - the seed for generated visits' planned sequence and the fallback ordering wherever a stop has no stored or computed rank.
StartTimeStart TimeTimeOnly
StatusStatusPickListRoute-membership state: Proposed, Approved or Rejected (null = legacy row, treated as Approved). Stops proposed from the mobile nearby-onboarding flow stay Proposed and generate no visits until an admin approves them; optimizers also only consider approved stops. Values: Proposed, Approved, Rejected.
StopNameStop NameText
SundayAvailableSunday AvailableBooleanYes
ThursdayAvailableThursday AvailableBooleanYes
TuesdayAvailableTuesday AvailableBooleanYes
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes
VisitPurposeVisit PurposePickListValues: Field Service, Order Capture, Courtesy Visit, Service Touch, Payment Collection, Asset Deactivation, Sale Order, Quote or Invoice Collection, New Asset Data Collection (FIR), Order Delivery, Product Demo.
VisitRouteIdVisit RouteLookup → VisitRoute
VisitTaskTemplateIdVisit Task TemplateLookup → VisitTaskTemplate
WednesdayAvailableWednesday AvailableBooleanYes
WeekNumbersWeek NumbersText

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete the selected records.
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete in a list page
EditEditEditEdit
EditDetailsEditEditEditDetails
EditEntityEditUIActionEditEntity
EditInLineEditEditEdit in page.
EditInListEditEditInlineEdit In List Header
NewNewNewNew

Lookup filters

FilterLookup fieldNotes
Customer AccountAccountId