xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField Sales & SFACRMRewardsClaimsInventoryProcurementWarehouse 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
Auto DMSConsumer Goods DMSSales Force Automation (SFA) 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 place on a beat (visit route): the customer account visited, its position in the authored order, an optional time window, its coordinates and a check-in tolerance. Every approved stop becomes one visit on each plan the beat generates, carrying the stop's account, start and end time, sequence number, visit purpose, geofencing tolerance and location. Stops proposed from the field app's nearby-onboarding flow are Proposed and generate no visits until approved; a proposal for an account already on the beat is refused. Outlet Transfer moves a stop to another beat by re-pointing it, so its visit history stays attached.

Fields

FieldLabelTypeRequiredWhat it does
AccountIdAccountLookup → AccountThe customer account visited at this stop. Only active customer accounts can be picked. Copied onto every visit generated from the stop.
AccountLocationAccount LocationGeoLocationThe stop's own coordinates. Copied onto generated visits as their planned position; when empty, the account's stored geo-location is used instead. Route optimization uses only this field, so stops without it trail at the end of an optimized order.
AllowedGeofencingToleranceAllowed Geofencing Tolerance (KM)NumberHow far from the outlet a check-in can be before the field app warns that the executive is off-site. Copied onto each generated visit. Although the label says KM, the field app reads the number in metres; empty means 100 metres. The warning does not stop the visit from starting.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DayNumbersDay NumbersTextDay numbers recorded on the stop. Plan generation does not read them; the route's schedule decides which days a plan is generated.
DurationDurationCalculated (calculated)Minutes between Start Time and End Time, calculated automatically; empty unless both are set.
EndTimeEnd TimeTimeOnlyThe planned end of the visit at this outlet, copied onto each generated visit as its planned end time. The latest end time among a beat's stops sets the plan's end.
FridayAvailableFriday AvailableBooleanYesAvailability switch recorded on the stop. Plan generation uses the route's day switches, not the stop's.
IdIdGuidYes
ModifiedByIdModified ByLookup → UserAccountYes
MondayAvailableMonday AvailableBooleanYesAvailability switch recorded on the stop. Plan generation uses the route's day switches, not the stop's.
NameNameText
OwnerIdOwnerLookup → UserAccountYes
RecordTypeIdRecord TypeGuid, hidden
RemarksRemarksTextFree-text notes about the stop. Stops proposed from the field app say they are an onboard request from the visit plan agenda.
SaturdayAvailableSaturday AvailableBooleanYesAvailability switch recorded on the stop. Plan generation uses the route's day switches, not the stop's.
SequenceNumberSequence NumberNumberThe stop's position in the authored (Planned) order of the beat. Generated visits take it as their sequence number and planned rank; stops with an empty number sort last. When a stop is transferred it is renumbered after the target beat's highest number.
StartTimeStart TimeTimeOnlyThe planned start of the visit at this outlet, copied onto each generated visit as its planned start time.
StatusStatusPickListThe stop's membership of the beat: Approved, Proposed or Rejected. Stops created on the web default to Approved; stops proposed from the field app are Proposed. Only Approved stops (or older stops with no status) generate visits and take part in route optimization. Values: Proposed, Approved, Rejected.
StopNameStop NameTextThe name the outlet carries on this beat. Stops proposed from the field app take the outlet's name.
SundayAvailableSunday AvailableBooleanYesAvailability switch recorded on the stop. Plan generation uses the route's day switches, not the stop's.
ThursdayAvailableThursday AvailableBooleanYesAvailability switch recorded on the stop. Plan generation uses the route's day switches, not the stop's.
TuesdayAvailableTuesday AvailableBooleanYesAvailability switch recorded on the stop. Plan generation uses the route's day switches, not the stop's.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes
VisitPurposeVisit PurposePickListWhy the outlet is visited. Copied onto each visit generated from the stop. Values: 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 → VisitRouteThe beat this stop belongs to. Changed only by Outlet Transfer, which re-points the stop so its visits and sequence history stay attached.
VisitTaskTemplateIdVisit Task TemplateLookup → VisitTaskTemplateA visit task template recorded on the stop. Plan generation does not use it: generated visits take the route's visit task template.
WednesdayAvailableWednesday AvailableBooleanYesAvailability switch recorded on the stop. Plan generation uses the route's day switches, not the stop's.
WeekNumbersWeek NumbersTextWeek-of-month numbers recorded on the stop. Plan generation does not read them; the route's schedule decides which weeks a plan is generated.

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