Visit

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

Supported Calls

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

Fields

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
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
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
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
Refers To: AcctMgrTarget, AdvAcctForecastSetPartner, AdvAcctForecastSetUse, Asset, Case, Claim, Data_Processing_Engine_Node_Metric__c, ManufacturingProgram, RebateProgram, SalesAgreement, ServiceAppointment, Vehicle, omnistudio__CardFrameworkConfiguration__c, omnistudio__DRBatchQueue__c, omnistudio__DRBulkData__c, omnistudio__DREncryption__c, omnistudio__DRWorker__c, omnistudio__Interface_DRGeneric__c, omnistudio__TestResult__c, omnistudio__TriggerSetup__c, omnistudio__UISettings__c, omnistudio__VlocityDataPack__c, omnistudio__VlocityDocuSignTemplate__c, omnistudio__VlocityErrorLogEntry__c, omnistudio__VlocityScheduledJob__c, omnistudio__VlocityTrackingEntry__c

CurrencyIsoCode

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Currency of the sales agreement.
Default value: USD
Possible values:
- ARS—Argentine Peso
- AUD—Australian Dollar
- BBD—Barbados Dollar
- BHD—Bahraini Dinar
- BMD—Bermuda Dollar
- BRL—Brazilian Real
- CAD—Canadian Dollar
- CLP—Chilean Peso
- CNY—Chinese Yuan
- CRC—Costa Rica Colon
- CZK—Czech Koruna
- DKK—Danish Krone
- DOP—Dominican Peso
- EUR—Euro
- FJD—Fiji Dollar
- GBP—British Pound
- GTQ—Guatemala Quetzal
- HKD—Hong Kong Dollar
- HRK—Kuna
- HUF—Hungarian Forint
- IDR—Indonesian Rupiah
- ILS—Israeli Shekel
- ISK—Iceland Krona
- JPY—Japanese Yen
- KYD—Cayman Islands Dollar
- MXN—Mexican Peso
- USD—U.S. Dollar
- VND—Vietnam Dong
- XCD—East Caribbean Dollar
- XPF—Pacific Franc

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 supplier, distributor, or partner where the visit must be conducted.

This field is a relationship field.
Relationship Name: Location
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
Refers To: Group, User

ParentVisitId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The parent visit associated with the current visit.

This field is a relationship field.
Relationship Name: ParentVisit
Refers To: Visit

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
Refers To: Address, ContactPointAddress, 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.

ServiceResourceId

Type: reference
Properties: Filter, Group, Nillable, Sort
Description:

This field is a relationship field.
Relationship Name: ServiceResource
Refers To: ServiceResource

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.

The default value is Planned.
Default value: Planned
Possible values:
- Abandoned
- Completed
- Error
- InProgress—In Progress
- None
- Planned
- Unscheduled

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
Refers To: User

VisitPriority

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The priority of the visit.
Possible values:
- 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
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
Refers To: Contact, ServiceResource, User