Newer Version Available

This content describes an older version of this product. View Latest

Visit

Represents information about a visit that a manager schedules for a field rep to perform, usually at dealer locations. This object is available in Automotive Cloud in API version 56.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field Details
AccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The account associated with the visit.
This field is a relationship field.
Relationship Name
Account
Relationship Type
Lookup
Refers To
Account
ActualVisitEndTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the visit ended.
ActualVisitStartTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the visit started.
AddressId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The address associated with the visit.
This field is a relationship field.
Relationship Name
Address
Relationship Type
Lookup
Refers To
Address
ContactId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The contact associated with the visit.
This field is a relationship field.
Relationship Name
Contact
Relationship Type
Lookup
Refers To
Contact
ContextId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The purpose of the visit.
This field is a polymorphic relationship field.
Relationship Name
Context
Relationship Type
Lookup
Refers To
Account__c, Case
InstructionDescription
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Special instructions provided by a manager that the visitor refers to during a visit.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user referenced this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The most recent date on which a user viewed this record.
LocationId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The location of the dealer or partner where the visit must be conducted.
This field is a relationship field.
Relationship Name
Location
Relationship Type
Lookup
Refers To
Location
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
Unique identifier for the visit record.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the visit record owner.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
PlaceId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
ID of the place that the visitor visits.
This field is a polymorphic relationship field.
Relationship Name
Place
Relationship Type
Lookup
Refers To
Address, Location
PlannedVisitEndTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the visit is expected to end.
PlannedVisitStartTime
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The date and time when the visit is expected to start.
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
The status of the visit. Visitors can’t edit this field.
Possible values are:
  • Abandoned
  • Completed
  • Error
  • InProgress—In Progress
  • None
  • Planned
  • Unscheduled
The default value is Planned.
StatusRemarks
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
The reasons for abandoning or completing the visit as provided by the visitor.
UserId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The user associated with the visit.
This field is a relationship field.
Relationship Name
User
Relationship Type
Lookup
Refers To
User
VisitPriority
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The priority of the visit.
Possible values are:
  • High
  • Low
  • Medium
VisitTypeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The type of visit such as inspection type, or work type.
This field is a polymorphic relationship field.
Relationship Name
VisitType
Relationship Type
Lookup
Refers To
WorkType
VisitorId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the person visiting the place.
This field is a polymorphic relationship field.
Relationship Name
Visitor
Relationship Type
Lookup
Refers To
Contact, ServiceResource, User

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

VisitChangeEvent
Change events are available for the object.
VisitFeed
Feed tracking is available for the object.
VisitHistory
History is available for tracked fields of the object.
VisitOwnerSharingRule
Sharing rules are available for the object.
VisitShare
Sharing is available for the object.