Salesforce Docs Portal

ProviderVisitRqstSample

Represents sample products requested to be shipped to the health care provider during a visit. This object is available in API version 65.0 and later.

Supported Calls

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

Fields

ActualDeliveryDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Date when the samples are delivered to the provider.

AdditionalInformation

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Information captured on signature capture or provider visit submission for auditability.

CurrencyIsoCode

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The ISO currency code associated with the currency values allowed by the Salesforce org. Available only for Salesforce orgs with the multicurrency feature enabled.
  • Default value: USD
  • Possible values:
    • USD—U.S. Dollar

DeliveryStatus

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Delivery status of the sample order.

DistributorName

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Name of the distributor for the samples.

ExpectedDeliveryDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Expected delivery date of the samples.

IsCalcForDirToPhysician

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates if the samples have been calculated for territory product quantity allocation.
  • Default value: false

IsSignatureCaptured

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the signature was captured.
  • Default value: false

IsTrackedForSmplTrxnLimit

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the samples are tracked in sample limit transaction.
  • Default value: false

LastReferencedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.

LastShippedQuantity

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Indicates the number of items in the previous shipment.

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last viewed this record or list view.

    If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly.

Name

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: Name of the provider visit requested sample.

OrderTrackingIdentifier

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Tracking number of the sample shipment.

OwnerId

  • Type: reference
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: ID of the owner or creator of this object.

    This field is a polymorphic relationship field.

  • Relationship Name: Owner
  • Refers To: Group, User

ProductId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Required. The sample product requested by the provider.

    This field is a relationship field.

  • Relationship Name: Product
  • Refers To: Product2

ProviderVisitId

  • Type: reference
  • Properties: Create, Filter, Group, Sort
  • Description: Required. The associated provider visit record.

    This field is a relationship field.

  • Relationship Name: ProviderVisit
  • Relationship Type: Master-detail
  • Refers To: ProviderVisit (the master object)

RequestedQuantity

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Requested quantity of samples.

ShippedQuantity

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Shipped quantity of the samples.

ShippingAddressId

  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Description: The shipping address associated with the provider visit requested sample.

    This field is a relationship field.

  • Relationship Name: ShippingAddress
  • Refers To: ContactPointAddress

ShippingDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Date when the samples are shipped.

SourceSystemIdentifier

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
  • Description: An external ID from the source system for data integrations.

SourceSystemName

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The name of the source system for data integrations.

ViolationType

  • Type: multipicklist
  • Properties: Create, Filter, Nillable, Update
  • Description: The type of violation.

VisitId

  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Description: Required. The associated visit record.

    This field is a relationship field.

  • Relationship Name: Visit
  • Relationship Type: Master-detail
  • Refers To: Visit (the master object)

WarningMessage

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Warning message displayed for the validation of territory product quantity allocation.

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.

ProviderVisitRqstSampleHistory
History is available for tracked fields of the object.