Skip to main content

Visit

One stop inside a journey plan: which customer, which employee, which date, and what actually happened when the employee arrived.

Stored in the VISIT layer.


Fields​

FieldRequiredWhat it is
visit_target_guidYesThe customer being visited
visit_assignee_usernameYesEmployee carrying out the visit
visit_dateYesScheduled date
visit_statusYes1 To do, 2 Checked in, 3 Done, 4 Cancelled
visit_priorityYes1 Lowest, 2 Low, 3 Medium, 4 High, 5 Highest
visit_objectiveYesWhat the visit is meant to achieve
visit_estiamte_timeExpected duration in minutes. Defaults to 30
visit_addressYesWhere the visit happens, normally copied from the customer
visit_locationGeoJSON Point (WGS84) of where the visit should happen
visit_boundaryGeoJSON Polygon (WGS84) used to check the visit happened in the right area
visit_postal_codeYesPostal code of the visit address
visit_administrative_1YesState of the visit address
visit_administrative_2YesDistrict of the visit address
visit_administrative_3YesTehsil of the visit address
visit_contact_full_nameYesWho to meet, normally the customer contact
visit_contact_phone_numberContact phone number
visit_contact_emailContact email
visit_ticket_noTicket number generated per customer when the plan is created
visit_checkin_timeWritten by the platform when the assignee checks in
visit_checkin_byWho checked in
visit_checkin_locationWhere the check-in happened
visit_checkout_timeWritten by the platform at checkout
visit_checkout_byWho checked out
visit_checkout_locationWhere the checkout happened
visit_checkout_formForm completed at checkout
visit_cancel_timeWhen the visit was cancelled
visit_cancel_byWho cancelled it
visit_cancel_reasonWhy it was cancelled
visit_time_trackingTime spent on the visit
visit_orderPosition of the visit inside the plan
visit_typeType of visit, which can decide the form to submit
visit_guidAssigned by the platform
visit_plan_guidThe plan this visit belongs to

Used by​