Visit — entity reference

One stop a field rep executes: a dated call on an outlet (accountId), normally generated under a VisitPlan from the route's stops (visitRouteStopId links back), from an account group's members, or from pending delivery orders. Lifecycle runs through visitStatus (Planned, Assigned, Started, Paused, Completed, Cancelled, Rescheduled); entering Started stamps the actual start (documentDate + startTime, kept on resume from Paused), Completed stamps endTime, and only the resource the plan is assigned to may move a visit into an execution state (VisitAssignmentGuard). Execution work hangs off child VisitTask rows (materialized from the visit's visitTaskTemplateId), and business documents created during the visit link back: the first Order/ServiceOrder created against the visit is stamped as its canonical orderId/serviceOrderId (never overwritten; later documents stay children via their own visitId). Also carries deliveryOrderId, invoiceId, paymentId and productDemoId links, the captured GPS point (visitLocation) versus the planned point (assignedLocation), and three stored orderings of the day's route (plannedSequence, optimizedSequence, mostlyFollowedSequence) behind the mobile Timeline/Map views.

Fields

Field	Label	Type	Required	What it does
`AccountGroupId`	Account Group	Lookup → AccountGroup
`AccountId`	Account	Lookup → Account
`AssignedLocation`	Assigned Location	GeoLocation		The planned position of the stop, stamped at visit generation from the route stop's own coordinates or, when the stop was authored without them, the account's stored geo-location. Geography point, JSON wire shape latitude/longitude.
`BranchId`	Branch	Lookup → Branch
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`DeliveryOrderId`	Delivery Order	Lookup → DeliveryOrder
`DocumentDate`	DocumentDate	DateAndTime		Stamped with the actual start timestamp (UTC) when the visit first enters Started - not a user-entered document date. Kept unchanged when a paused visit resumes.
`EndTime`	End Time	TimeOnly
`GeofencingTolerance`	Geofencing Tolerance (KM)	Number
`Id`	Id	Guid	Yes
`InvoiceId`	Invoice	Lookup → Invoice
`Latitude`	Latitude	Decimal
`Longitude`	Longitude	Decimal
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`MostlyFollowedSequence`	Mostly Followed Sequence	Number		The order reps have mostly followed historically on this route: the average actual visit order by start time across earlier plans, copied from the current MostlyFollowed RouteSequence (or computed inline for routes without stored history). Null when the route has no history yet.
`Name`	Name	Text
`NonProductiveReason`	Non-Productive Reason	PickList		Why a visit produced no business outcome (picklist). The grain of the Non-Productive Visit report, which groups these by the plan's assigned executive.
`OptimizedSequence`	Optimized Sequence	Number		The geo-optimized order for this plan's visits: copied from the route's current Optimized RouteSequence at generation (nearest-neighbour, or real road-network order when the paid optimizer ran), and refreshed by the plan's OptimizeRoute action.
`OrderId`	Order	Lookup → Order		The visit's canonical sales order under the one-order-per-visit rule: stamped automatically when the first Order is created against the visit, and never overwritten - later orders for the same visit remain children via Order.visitId only.
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PartnerAccountId`	Partner Account	Lookup → Account
`PaymentId`	Payment	Lookup → Payment
`PlannedDate`	Planned Date	Date
`PlannedDuration`	Planned Duration	Calculated (calculated)
`PlannedEndTime`	Planned End Time	TimeOnly
`PlannedSequence`	Planned Sequence	Number		The authored route order as planned: seeded from the route stops' sequence at generation and updated together with sequenceNumber when the planned order is deliberately restamped. One of three stored orderings behind the Timeline/Map route views.
`PlannedStartTime`	Planned Start Time	TimeOnly
`ProductDemoId`	Appointment	Lookup → ProductDemo
`RecordTypeId`	Record Type	Guid, hidden
`Remarks`	Remarks	MultiLineText
`SequenceNumber`	Sequence Number	Number		The canonical CURRENT order of the visit within its plan - what the mobile Timeline walks. Seeded from the route stop sequence, kept in sync by the rep's drag-reorder, and rewritten by ApplySequenceToPlan and OptimizeRoute (with apply).
`ServiceOrderId`	Service Order	Lookup → ServiceOrder		The visit's canonical service order: stamped automatically when the first ServiceOrder is created against the visit and never overwritten afterwards - later service orders stay children via their own visitId.
`ShowAcceptRejectOption`	Show Accept/Reject Option	Boolean	Yes
`ShowGetDirectionOption`	Show Get Direction Option	Boolean	Yes
`ShowProgressPanel`	Show Progress Panel	Boolean
`ShowRescheduleOption`	Show Reschedule Option	Boolean	Yes
`ShowVisitStartEndOption`	Show Visit Start/End Option	Boolean	Yes
`StartTime`	Start Time	TimeOnly
`UIProps`	UI Props	Text
`UpdatedDateTime`	Modified Date	DateAndTime	Yes
`VisitCancellationReason`	Visit Cancellation Reason	PickList		Values: Insufficient Information, Non Availability.
`VisitCity`	Visit City	PickList		Values: Pune, Chandigarh, Mumbai.
`VisitContactAddressId`	Visit Address	Lookup → ContactAddress
`VisitCountry`	Visit Country	PickList		Values: India.
`VisitDate`	Visit Date	Date
`VisitDuration`	Visit Duration	Calculated (calculated)		Derived, not stored input: minutes between startTime and endTime (0 until both are set). Writing to it has no effect.
`VisitLocation`	Visit Location	GeoLocation		The GPS point captured during execution, stored as a geography point (SRID 4326); the JSON wire shape is an object with latitude and longitude. Compare with assignedLocation, the planned position.
`VisitPlanId`	Visit Plan	Lookup → VisitPlan
`VisitPostalCode`	Visit Postal Code	Text
`VisitPurpose`	Visit Purpose	PickList		Values: Payment Collection, Order Capture, Order Delivery, Field Service, Product Demo, Courtesy Visit, Service Touch.
`VisitRegion`	Visit Region	Text
`VisitRouteId`	Visit Route	Lookup → VisitRoute
`VisitRouteStopId`	Visit Route Stop	Lookup → VisitRouteStop
`VisitState`	Visit State	PickList		Values: Maharashtra, Punjab, New Delhi, Haryana.
`VisitStatus`	Visit Status	PickList		Execution lifecycle: Planned, Assigned, Started, Paused, Completed, Cancelled, Rescheduled (the mobile client also uses Ongoing for Started). First entry into Started stamps documentDate and startTime (a resume from Paused keeps the originals); Completed stamps endTime. Transitions into execution states are restricted to the plan's assigned resource, and plan completion force-cancels visits not already Completed/Cancelled/Rescheduled. Values: Planned, Assigned, Started, Completed, Rescheduled, Cancelled.
`VisitStreet`	Visit Street	Text
`VisitTaskTemplateId`	Visit Task Template	Lookup → VisitTaskTemplate		The execution playbook for this visit. Setting or changing it regenerates the visit's VisitTask rows from the template's entries - existing tasks are removed and recreated, so it is not a passive reference.
`VisitTimeDeviation`	Visit Time Deviation	Calculated (calculated)		Derived: plannedStartTime minus actual startTime in minutes (positive = started early, negative = late; 0 until both exist). Writing to it has no effect.

Actions

Action	Label	Type	What it does
`BulkDelete`	Delete	Delete	Delete
`Clone`	Clone	ServerAction (`Clone`)	Create a copy of this record
`ConvertLead`	Convert Lead 2	ServerAction (`serverActionConvert`)	asdf
`Delete`	Delete	Delete	Delete
`DeleteInList`	Delete	Delete	Delete
`Edit`	Edit	Edit	Edit
`EditInLine`	Edit	EditInline	Edit
`EditInList`	Edit	EditInline	Edit In List Header
`EditPopup`	Edit	Edit	Edit
`GetNearbyToOnboard`	Get Nearby To Onboard	ServerAction (`GetNearbyToOnboard`), hidden	Read-only feed for the mobile agenda: returns existing Accounts within a radius of the visit's location that are not yet on the plan or route, plus not-yet-onboarded ProspectPlace rows, both ranked by geodesic distance. Origin is the supplied currentLocation, else the visit's captured location, else its assigned location - with none of these it fails validation. Args radiusMeters (default 3000, max 100000) and maxResults (default 8, max 50). Creates nothing and calls no external provider.
`New`	New	New	New

Lookup filters

Filter	Lookup field	Notes
Branch For Partner Account	`BranchId`
Only Partner Account	`PartnerAccountId`

VisitPlan — looks up via VisitPlanId
Branch — looks up via BranchId
AccountGroup — looks up via AccountGroupId
Account — looks up via AccountId
DeliveryOrder — looks up via DeliveryOrderId
Order — looks up via OrderId
ServiceOrder — looks up via ServiceOrderId
VisitRoute — looks up via VisitRouteId
UserAccount — looks up via OwnerId
Payment — looks up via PaymentId
Invoice — looks up via InvoiceId
VisitTaskTemplate — looks up via VisitTaskTemplateId
UserAccount — looks up via CreatedById
Account — looks up via PartnerAccountId
VisitRouteStop — looks up via VisitRouteStopId
ContactAddress — looks up via VisitContactAddressId
UserAccount — looks up via ModifiedById
ProductDemo — looks up via ProductDemoId
Invoice — referenced by via VisitId
VisitTaskActivity — referenced by via VisitId
DeliveryOrder — referenced by via VisitId
VisitTask — referenced by via VisitId
ShelfAuditResult — referenced by via VisitId
Order — referenced by via VisitId

Visit — entity reference

Fields

Actions

Lookup filters

Related entities

Related topics