Visit Plan — entity reference

One executive's field day: a dated plan holding one visit per outlet, assigned to the resource who will walk it. Plans are generated automatically from a visit route's schedule (status Planned), created by hand, created from the Route Planner page, or created by a van run. On first save, visits are built from the plan's sources: one per approved stop of the Visit Route, one per member of the Account Group, and, when Visit Purpose is Order Delivery, one per undelivered delivery order of the plan's branch and partner account that is not linked to a visit yet. Saving a plan with a route copies the route's Partner Account, Visit Purpose and Visit Task Template onto it and fills an empty assignee from the route. Changing the route, account group, purpose or dates later adds visits again without removing existing ones. Only the assigned resource may start, pause or end the plan. Setting Status to Completed cancels every visit not already Completed, Cancelled or Rescheduled. An open plan older than the Sales setting 'Auto-cancel Visit Plan after' (72 hours by default) is set to Lapsed and its open visits are cancelled.

Fields

Field	Label	Type	Required	What it does
`AcceptanceStatus`	Acceptance Status	PickList		Descriptive value (Accept, Decline, Not Sure); nothing in plan processing reads it. Values: Accept, Decline, Not Sure.
`AccountGroupId`	Account Group	Lookup → AccountGroup		When set, one visit is created for every member of the account group (member active flags are not checked). Changing it on a saved plan adds a further set of visits. Not on the seeded forms.
`ActualPlanEndDate`	Actual Plan End Date	DateAndTime		When the executive pressed End plan, or when the stale-plan cleanup lapsed the plan if it was still empty.
`ActualPlanStartDate`	Actual Plan Start Date	DateAndTime		When the executive pressed Start plan. Only the assigned resource can set it.
`AssignedToResourceId`	Assigned To Resource	Lookup → Resource		The executive who will walk the day, and the only person allowed to execute it. Filled when empty: from the route's resource, or the holder of the route's position on a seat-owned route; on a plan without a route, from the creating user's resource. Users linked to a resource only see plans assigned to them or their hierarchy, plus unassigned plans.
`BranchId`	Branch	Lookup → Branch		The branch the day belongs to; the picker shows only branches of the chosen partner account. Generated plans take the assigned resource's default branch. Order Delivery plans only pick up delivery orders of this branch.
`City`	City	PickList		Values: New Delhi.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`EndLocation`	End Location	GeoLocation		Fixed end point for Optimise Route. Not on the seeded forms.
`ExecutedByResourceId`	Executed By Resource	Lookup → Resource		Who actually ran the day. Van-run plans set it to the run's executive. When no assignee is set, this resource is the one allowed to execute the plan. Changing it counts as execution, so it is refused for a user linked to a resource other than the assignee.
`Id`	Id	Guid	Yes
`IncludePendingDeliveryCheckouts`	Include Pending Delivery Checkouts	Boolean		Stored only; nothing in plan processing reads it.
`IncludePendingDeliveryOrders`	Include Pending Delivery Orders	Boolean	Yes	Stored only; delivery visits are driven by Visit Purpose Order Delivery, not by this switch.
`ItemGroupId`	Item Group	Lookup → ItemGroup
`ModeofTransport`	Mode of Transport	PickList		Values: Two Wheeler.
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Name	Text		The day's name, required on the form. Generated plans are named after the route and the date, for example 'North Market - 14 Oct 2026'. Automatic numbering is available through the Visit Plan document name setting, which is delivered switched off.
`OwnerId`	Owner	Lookup → UserAccount	Yes
`PartnerAccountId`	Partner Account	Lookup → Account		The distributor or company the day serves. Overwritten with the route's partner account whenever the plan is saved with a Visit Route. Used together with Branch to pick delivery orders for Order Delivery plans.
`PlanEndDate`	Plan End Date	DateAndTime		When the day is planned to end. Generated plans use the latest end time among the route's approved stops. The stale-plan cleanup measures from this date, or from Plan Start Date when it is empty.
`PlanName`	PlanName	LongMultiLineText		A copy of the plan name written by automatic generation.
`PlanStartDate`	Plan Start Date	DateAndTime		The planned day. Becomes the planned date of every visit created for the plan. Generated plans start at the route's start time on the day, or midnight.
`PlanType`	Plan Type	PickList		Order Taking (default), Van Sales or Field Service. Set by van runs and the Route Planner; not on the seeded forms. On mobile, Van Sales and Field Service plans show the Van Run card. Starting the plan is not blocked until the van stock is taken in. Values: Order Taking, Van Sales, Field Service.
`PostalCode`	Postal Code	Text
`RecordTypeId`	Record Type	Guid, hidden
`Remarks`	Remarks	Text
`RouteMethod`	Route Method	PickList		Descriptive value. Route Planner and van-run plans store Manual, which is not one of the picklist values; nothing in plan processing reads it. Values: By Map Selection, By Pincode, By Account Group.
`StartLocation`	Start Location	GeoLocation		Fixed starting point for Optimise Route when no current location is supplied. Not on the seeded forms.
`State`	State	PickList
`Status`	Status	PickList		The plan's lifecycle. Hand-created plans start as Draft. Generated, Route Planner and van-run plans are saved as Planned; Start plan writes In Progress, Pause writes Paused, End plan writes Completed and the stale-plan cleanup writes Lapsed — several of these values are written by the system without being picklist values. Only the assigned resource can move a plan into In Progress, Started, Paused, Completed or Executed. Moving to Completed cancels every visit that is not Completed, Cancelled or Rescheduled; moving to Cancelled leaves visits unchanged. Values: Draft, Assigned, Started, Executed, Lapsed, Cancelled, Completed.
`TotalVisit`	Total Visit	Calculated (calculated)		Number of visits on the plan.
`UIProps`	UI Props	Text
`UpdatedDateTime`	Modified Date	DateAndTime	Yes
`VisitCompliance`	Visit Compliance	Calculated (calculated)		Percentage of the plan's visits whose status is Completed: completed visits times 100 divided by all visits, 0 when the plan has no visits.
`VisitPurpose`	Visit Purpose	PickList		Why the outlets are visited. Copied from the route when the plan has one. The value Order Delivery adds one visit per undelivered, unlinked delivery order of the plan's branch and partner account that is unscheduled or scheduled on the plan's day. Values: Order Capture, Courtesy Visit, Order Delivery, Field Service, Product Demo, Service Touch, Payment Collection.
`VisitRouteGroupId`	Visit Route Group	Lookup → VisitRouteGroup		The route group of the plan's route, copied by automatic generation.
`VisitRouteId`	Visit Route	Lookup → VisitRoute		The visit route (beat) the plan comes from. On first save one visit is created per approved stop (stops with no status also count; Proposed stops are skipped), carrying the stop's times, position and purpose. Changing it on a saved plan adds visits again and copies the route's partner account, purpose and task template.
`VisitTaskTemplateId`	Visit Task Template	Lookup → VisitTaskTemplate		The task template stamped on every visit the plan creates; tasks and activities are created by the apps when a visit is first opened. Copied from the route when the plan has one.

Actions

Action	Label	Type	What it does
`ApplySequenceToPlan`	Apply Sequence To Plan	ServerAction (`ApplySequenceToPlan`), inactive	Stamps this plan's visits with a stored RouteSequence's ordering as the new PLANNED order: rewrites sequenceNumber and plannedSequence, compacted to 1..n over the plan's visits, with visits whose stop is not in the sequence trailing in their current order. Args: routeSequenceId (required guid). Returns the count of visits re-sequenced.
`BulkDelete`	Delete	Delete	Delete the selected records.
`ClearRoute`	Clear Route	UIAction, inactive	Clear Route
`Clone`	Clone	ServerAction (`Clone`), inactive	Create a copy of this record
`ConfigureRoute`	Configure Route	UIAction, inactive	Configure Route
`Delete`	Delete	Delete	Delete
`DeleteInList`	Delete	Delete	Delete in a list page
`Edit`	Edit	Edit	Edit
`EditInLine`	Edit	EditInline	Edit in page.
`EditInList`	Edit	Edit	Edit In List Header
`EditListHeader`	Edit	EditInline	EditListHeader
`GetAllVisits`	View All Visits	ServerAction (`GetAllVisits`)	Read-only fetch of every Visit belonging to this plan, each returned with its account and task template embedded - the data source behind the plan's all-visits view. Modifies nothing.
`New`	New	New	New
`OptimiseRoute`	Optimise Route	ServerAction (`OptimizeRoute`)	Optimise Route

Lookup filters

Filter	Lookup field	Notes
Branch For Partner Account	`BranchId`

Account — looks up via PartnerAccountId
VisitRoute — looks up via VisitRouteId
Resource — looks up via ExecutedByResourceId
UserAccount — looks up via ModifiedById
ItemGroup — looks up via ItemGroupId
Resource — looks up via AssignedToResourceId
AccountGroup — looks up via AccountGroupId
VisitTaskTemplate — looks up via VisitTaskTemplateId
UserAccount — looks up via OwnerId
UserAccount — looks up via CreatedById
VisitRouteGroup — looks up via VisitRouteGroupId
Branch — looks up via BranchId
Visit — referenced by via VisitPlanId
Order — referenced by via VisitPlanId
Invoice — referenced by via VisitPlanId
ProspectPlace — referenced by via VisitPlanId

Visit Plan — entity reference

Fields

Actions

Lookup filters

Related entities

Related topics