One rep's route execution over a date window (planStartDate..planEndDate): the container the day's Visits are generated into. On create (and on relevant updates) the handler cascades generation - one visit per stop of the linked route (visitRouteId; the stored current RouteSequence orderings are stamped onto the visits), or one per member of accountGroupId, or one per pending delivery order when visitPurpose is Order Delivery - and defaults partner, purpose and task template from the route. assignedToResourceId names the rep meant to walk it (resolved from the route's seat holder when the route is position-owned, else the route's resource) and only that rep may execute (VisitAssignmentGuard); executedByResourceId records who actually did. Setting Status to Completed cancels every child visit that is not already Completed, Cancelled or Rescheduled; settled plan statuses are Completed, Executed, Cancelled and Lapsed. planType distinguishes Order Taking (default), Van Sales and Field Service execution modes.
Fields
| Field | Label | Type | Required | What it does |
|---|
AcceptanceStatus | Acceptance Status | PickList | | Values: Accept, Decline, Not Sure. |
AccountGroupId | Account Group | Lookup → AccountGroup | | |
ActualPlanEndDate | Actual Plan End Date | DateAndTime | | |
ActualPlanStartDate | Actual Plan Start Date | DateAndTime | | |
AssignedToResourceId | Assigned To Resource | Lookup → Resource | | The rep meant to walk the route - the identity the execution guard compares against. Auto-resolved for plans created by hand or API against a route: the route's seat holder when the route is position-owned, else the route's resource; an explicit assignee is never overridden. Salesperson-specific stored route orderings are also picked by this resource. |
BranchId | Branch | Lookup → Branch | | |
City | City | PickList | | Values: New Delhi. |
CreatedById | Created By | Lookup → UserAccount | Yes | |
CreatedDateTime | Created Date | DateAndTime | Yes | |
EndLocation | End Location | GeoLocation | | When set, the route optimizer treats it as the fixed endpoint of the plan's optimized visit order. Geography point, wire shape latitude/longitude. |
ExecutedByResourceId | Executed By Resource | Lookup → Resource | | Who actually executed the plan, as distinct from assignedToResourceId (who it was allocated to). Reported side by side in visit compliance reporting. |
Id | Id | Guid | Yes | |
IncludePendingDeliveryCheckouts | Include Pending Delivery Checkouts | Boolean | | |
IncludePendingDeliveryOrders | Include Pending Delivery Orders | Boolean | Yes | |
ItemGroupId | Item Group | Lookup → ItemGroup | | |
ModeofTransport | Mode of Transport | PickList | | Values: Two Wheeler. |
ModifiedById | Modified By | Lookup → UserAccount | Yes | |
Name | Name | Text | | |
OwnerId | Owner | Lookup → UserAccount | Yes | |
PartnerAccountId | Partner Account | Lookup → Account | | |
PlanEndDate | Plan End Date | DateAndTime | | |
PlanName | PlanName | LongMultiLineText | | |
PlanStartDate | Plan Start Date | DateAndTime | | |
PlanType | Plan Type | PickList | | Execution mode: Order Taking (default), Van Sales or Field Service. Van Sales / Field Service plans dispatch stock to a mobile storage location (the van) and gate plan start on the load take-in. Values: Order Taking, Van Sales, Field Service. |
PostalCode | Postal Code | Text | | |
RecordTypeId | Record Type | Guid, hidden | | |
Remarks | Remarks | Text | | |
RouteMethod | Route Method | PickList | | Values: By Map Selection, By Pincode, By Account Group. |
StartLocation | Start Location | GeoLocation | | Geography point the road-network route optimizer anchors on when the rep's current location is not supplied to OptimizeRoute. Wire shape latitude/longitude. |
State | State | PickList | | |
Status | Status | PickList | | Plan lifecycle. Execution states (In Progress, Started, Paused, Completed, Executed) may only be entered by the assigned resource; settled states are Completed, Executed, Cancelled and Lapsed. The transition to Completed cancels every child visit that is not already Completed, Cancelled or Rescheduled, in the same save. Values: Draft, Assigned, Started, Executed, Lapsed, Cancelled, Completed. |
TotalVisit | Total Visit | Calculated (calculated) | | total visit in a visit plan |
UIProps | UI Props | Text | | |
UpdatedDateTime | Modified Date | DateAndTime | Yes | |
VisitCompliance | Visit Compliance | Calculated (calculated) | | how many visit has been completed under a visit plan |
VisitPurpose | Visit Purpose | PickList | | Defaulted from the route. The value Order Delivery is load-bearing: it makes plan generation create visits from pending, undelivered delivery orders matching the plan's branch, partner and date window. Values: Order Capture, Courtesy Visit, Order Delivery, Field Service, Product Demo, Service Touch, Payment Collection. |
VisitRouteGroupId | Visit Route Group | Lookup → VisitRouteGroup | | |
VisitRouteId | Visit Route | Lookup → VisitRoute | | |
VisitTaskTemplateId | Visit Task Template | Lookup → VisitTaskTemplate | | |
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 | |
