Visit

Track information related to a field rep’s visit to a retail store where they perform retail activities. This object is available in API version 47.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 that is associated with a visit. This field is available in API versions 48.0 and later.
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 of the retail store where the visit must be conducted. This field is available in API versions 52.0 and later. Not applicable for the enhanced model of Consumer Goods cloud. This is a relationship field. Relationship Name Address Relationship Type Lookup Refers To Address
cgcloud__Account_City__c	Type string Properties Filter, Nillable, Sort Description City of the related account. This is a calculated field.
cgcloud__Account_Street__c	Type string Properties Filter, Nillable, Sort Description Street name of the related account.
cgcloud__Accountable__c	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The accountable user for this visit. System sets the initiator of the visit as the initial accountable user.
cgcloud__Completed_Date__c	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date the visit was completed.
cgcloud__Creation_Date_and_Time__c	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Date and time the visit was created.
cgcloud__Creation_Mode__c	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Specifies the way the visit was created. Possible values are manually or automatic. The default value is manually.
cgcloud__Date_mock__c	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Help/Mock field to visualize calendar in visual force page. Value of this field won't be saved in the database.
cgcloud__Distribution_Rate_All__c	Type double Properties Create, Filter, Nillable, Sort, Update Description Distribution rate of all products. The system calculates and stores the 'Distribution Rate of All Products' (DRallP) as percentage value.
cgcloud__Distribution_Issue__c	Type double Properties Create, Filter, Nillable, Sort, Update Description This is a KPI Field calculated based on the distribution rate of all products. The system caluclates and stores the 'Distribution Issues' (DI) as boolean value.
cgcloud__Duration_Effective__c	Type double Properties Create, Filter, Nillable, Sort, Update Description Effective visit duration captured via time tracking. Only implemented in mobile, will remain empty if visit is completed on desktop.
cgcloud__Duration_In_Minutes__c	Type double Properties Filter, Nillable, Sort Description Planned duration of the visit (difference between planned start and end data). This is a calculated field.
cgcloud__End_Date__c	Type date Properties Filter, Group, Nillable, Sort Description Planned end date of the visit.
cgcloud__Fixed_Visit_Date__c	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Specifies that this visit was scheduled with the customer at a fixed date and time. Attribute can be used to implement a logic which will not allow to move the visit to a different date or time. Possible values are 0 (No) and 1 (Yes). The default value is 0.
cgcloud__Geolocation__c	Type location Properties Nillable Description Geo coordinates (Latitude and Longitude) of the position from the user taken on the mobile device during the visit completion or cancellation.
cgcloud__IsAllDayEvent__c	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Visit is planned for the entire day. Weekly calendar visualizes such visits in the header of the day. The default value is false.
cgcloud__Is_Vst_Cmpl_Osid_Range__c	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the visit completed outside the allowed distance between the GPS location and the store’s geolocation. The default value is false.
cgcloud__Is_Vst_Start_Osid_Range__c	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the visit started outside the allowed distance between the GPS location and the store’s geolocation. The default value is false.
cgcloud__Note__c	Type textarea Properties Create, Nillable, Update Description Visit notes which can be captured to prepare the visit or during execution time.
cgcloud__Responsible__c	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Responsible user for this visit.
cgcloud__Start_Date__c	Type date Properties Filter, Group, Nillable, Sort Description Planned start date of the visit.
cgcloud__Start_Geolocation__c	Type Geolocation Properties Create, Filter, Group, Nillable, Sort, Update Description Customer’s location coordinates (latitude and longitude) at the start of a visit.
cgcloud__Subject__c	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Subject of the visit.
cgcloud__Subject_Formula__c	Type string Properties Filter, Nillable, Sort Description This field is required when subject needs to be displayed in a formula format. This is a calculated field.
cgcloud__Visit_Planned_Date__c	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Planned date for the visit.
cgcloud__Visit_Template__c	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Template of the visit. This field is a relationship field.
ContactId	Type reference Properties Filter, Group, Nillable, Sort Description The person to contact at the retail store during a visit. This field is available in API versions 52.0 and later. Not applicable for the enhanced model of Consumer Goods cloud. This 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 a visit, such as claim, business license application, or work type. This field is available in API versions 48.0 and later. Not applicable for the enhanced model of Consumer Goods cloud.
CreatedById	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description User who created the visit.
CreatedDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date the visit was created.
InstructionDescription	Type textarea Properties Create, Filter, Nillable, Sort, Update Description Special instructions provided by a sales manager or an admin that a sales rep refers to during a visit. Not applicable for the enhanced model of Consumer Goods cloud.
LastModifiedById	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description User who last modified the visit.
LastModifiedDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Date and time of the last modification for this 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 retail store where visit must be conducted. This field is available in API versions 52.0 and later. This 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.
PlaceId	Type reference Properties Create, Filter, Group, Sort, Update Description ID of the place that sales reps visit.
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.
RetailStoreId	Type reference Properties Filter, Group, Nillable, Sort Description The retail store where the visit is conducted. This field is available in API versions 52.0 and later. Used in CG Cloud base model to assign a retail store. Not applicable for the enhanced model of Consumer Goods cloud. This is a relationship field. Relationship Name RetailStore Relationship Type Lookup Refers To RetailStore
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description The status of the visit. Sales reps’ can’t edit this field. Possible values are: `Abandoned` `Completed` `InProgress` `Planned` `Unscheduled` `None` `Error` The default value is Planned. This is a static picklist. The values of the picklist aren’t displayed in the Object Manager. Note
StatusRemarks	Type textarea Properties Create, Filter, Nillable, Sort, Update Description The reasons for abandoning or completing the visit as provided by the sales rep. Not applicable for the enhanced model of Consumer Goods cloud.
VisitPriority	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The priority of the visit. Possible values are: `High` `Low` `Medium` Not applicable for the enhanced model of Consumer Goods cloud.
VisitorId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the sales representative visiting the store. Not applicable for the enhanced model of Consumer Goods cloud.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

VisitShare: Sharing is available for the object.
VisitFeed: Feed is available for the object.
VisitHistory: History is available for the object.
VisitOwnerSharingRule: Sharing rule is available for the object.

Consumer Goods Cloud Developer Guide

Visit

Supported Calls

Fields

Associated Objects