Visit

A planned or unplanned visit to a customer.

type Visit {
  checkIns: [VisitCheckIn!]!
  completedAt: DateTime
  createdAt: DateTime!
  hasUnreadMessage: Boolean!
  id: ID!
  journeyPlanId: String
  locationMissing: Boolean!
  noOrderReason: String
  notes: String
  outcome: VisitOutcome
  partnerHasLocation: Boolean!
  partnerId: String!
  partnerLatitude: Float
  partnerLongitude: Float
  partnerName: String
  salesRepId: String!
  sequence: Int!
  status: VisitStatus!
  updatedAt: DateTime!
  visitDate: DateTime!
}

Fields

Visit.checkIns ● [VisitCheckIn!]! non-null object

The check-ins of the visit.

Visit.completedAt ● DateTime scalar

When the visit was completed, as the rep's device reported it.

Visit.createdAt ● DateTime! non-null scalar

When the record was created.

Visit.hasUnreadMessage ● Boolean! non-null scalar

True when an unread message from the office is waiting on this stop.

Visit.id ● ID! non-null scalar

The unique ID of this record.

Visit.journeyPlanId ● String scalar

The ID of the day plan. Empty for an unplanned visit the rep created.

Visit.locationMissing ● Boolean! non-null scalar

True when the route generator could not find the customer's address coordinates. The stop was still assigned to a day.

Visit.noOrderReason ● String scalar

Why no order was taken.

Visit.notes ● String scalar

Notes about the visit.

Visit.outcome ● VisitOutcome enum

How the visit ended.

Visit.partnerHasLocation ● Boolean! non-null scalar

True when the customer has an address or map pin the stop can be routed to.

Visit.partnerId ● String! non-null scalar

The ID of the partner.

Visit.partnerLatitude ● Float scalar

The latitude of the customer's address.

Visit.partnerLongitude ● Float scalar

The longitude of the customer's address.

Visit.partnerName ● String scalar

The name of the customer.

Visit.salesRepId ● String! non-null scalar

The ID of the rep.

Visit.sequence ● Int! non-null scalar

The position of the stop in the day.

Visit.status ● VisitStatus! non-null enum

The status of the visit.

Visit.updatedAt ● DateTime! non-null scalar

When the record was last changed.

Visit.visitDate ● DateTime! non-null scalar

The day of the visit.

Returned By

addUnplannedVisit mutation ● cancelVisit mutation ● checkInVisit mutation ● checkOutVisit mutation ● completeVisit mutation ● myVisits query ● myVisitsRange query ● reorderVisits mutation ● rescheduleVisit mutation

Member Of

JourneyPlan object