Referral

AuthorizationStatus

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
• Description: Specifies the authorization status of the referral for the associated provider.
• Possible values:
  • Authorized
  • InReview—In Review
  • Rejected
  • Submitted

CaseId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The case associated with the referral.

  This field is a relationship field.

• Relationship Name: Case
• Refers To: Case

Category

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The category of referral.

ClientBusinessName

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The name of the referred business.

ClientEmail

• Type: email
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The email address of the referral.

ClientId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The account associated with the referral.

  This field is a relationship field.

• Relationship Name: Client
• Refers To: Account

ClientLanguage

• Type: multipicklist
• Properties: Create, Filter, Nillable, Update
• Description: The languages that the referral speaks.

ClientName

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The name of the referral.

ClientPhone

• Type: phone
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The phone number of the referral.

Comments

• Type: textarea
• Properties: Create, Nillable, Update
• Description: Additional details about the referral.

Description

• Type: textarea
• Properties: Create, Nillable, Update
• Description: The description of the referral.

EstimatedReferralValue

• Type: currency
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The estimated business value of the referred product, such as target asset under management (AUM), anticipated loan amount, or policy premium.

IsBusinessReferral

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Indicates whether the referral represents a business entity or not.
• Default value: false

IsSelfReferred

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Indicates whether the referral is made by the client.
• Default value: false

LastReferencedDate

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

LastViewedDate

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

Name

• Type: string
• Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
• Description: Name of the referral.

OpportunityId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: ID of the associated Opportunity.

  This field is a relationship field.

• Relationship Name: Opportunity
• Refers To: Opportunity

OutboundSourceId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The source of an outbound referral.

  This field is a polymorphic relationship field.

• Relationship Name: OutboundSource
• Refers To: ApplicationForm, Case, Referral

OwnerId

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

  This field is a polymorphic relationship field.

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

Priority

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Indicates the priority of the referral.

Product2Id

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The ID of the product that the referral wants to buy.

  This field is a relationship field.

• Relationship Name: Product2
• Refers To: Product2

ProductCategoryId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The category that products are organized in.

  This field is a relationship field.

• Relationship Name: ProductCategory
• Refers To: ProductCategory

ProviderEmail

• Type: email
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The email address of the person or the organization that the client is being referred to.

ProviderId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The account or contact associated with the person or the organization that the client is being referred to.

  This field is a polymorphic relationship field.

• Relationship Name: Provider
• Refers To: Account, Contact, HealthcareProvider

ProviderName

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The name of the person or the organization that the client is being referred to.

ProviderOrg

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The organization that the client is being referred to.

ProviderPhone

• Type: phone
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The phone number of the person or the organization that the client is being referred to.

ReferralDate

• Type: date
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The date on which the referral is received.

ReferralScore

• Type: int
• Properties: Create, Filter, Group, Sort, Update
• Description: Determines the likelihood of the referral buying the product.

ReferralType

• Type: picklist
• Properties: Create, Filter, Group, Restricted picklist, Sort, Update
• Description: Specifies whether the referral is inbound or outbound.
• Possible values:
  • INBOUND—Inbound
  • OUTBOUND—Outbound

ReferredPartyId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The ID of the referred party.

  This field is a polymorphic relationship field.

• Relationship Name: ReferredParty
• Refers To: Account, Contact, Lead

ReferrerContactId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The contact associated with the person or the organization that referred the client.

  This field is a relationship field.

• Relationship Name: ReferrerContact
• Refers To: Contact

ReferrerEmail

• Type: email
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The email address of the person or the organization that referred the client.

ReferrerId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The account or contact associated with the person or the organization that referred the client.

  This field is a polymorphic relationship field.

• Relationship Name: Referrer
• Refers To: Account, Contact, LoyaltyProgramMember, User

ReferrerName

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The name of the person or the organization that referred the client.

ReferrerOrg

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The organization that referred the client.

ReferrerPhone

• Type: phone
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The phone number of the person or the organization that referred the client.

Result

• Type: textarea
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The outcome of the referral.

ResultCategory

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
• Description: Specifies the category of the referral result.
• Possible values:
  • Approved
  • Client Declined Services
  • Pending
  • Referred Elsewhere
  • Rejected

Source

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The source of the referral.
• Possible values:
  • Application
  • Email
  • Message
  • Other
  • Phone
  • Social Media
  • Walk-In

SourceOrgIdentifier

• Type: string
• Properties: Create, Filter, Group, Sort, Update
• Description: The unique identifier of the org where the referrer submitted the referral form.

SourceReferralIdentifier

• Type: string
• Properties: Create, Filter, Group, Sort, Update
• Description: The unique identifier of the referral record in the source org.

Status

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Specifies the status of the referral.
• Possible values:
  • Approved
  • Enrolled
  • In Review
  • New
  • Rejected

Title

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The title of the referral.

UsageType

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Specifies the usage of the referral.

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.

ReferralChangeEvent

Change events are available for the object.

ReferralFeed

Feed tracking is available for the object.

ReferralHistory

History is available for tracked fields of the object.

ReferralOwnerSharingRule

Sharing rules are available for the object.

ReferralShare

Sharing is available for the object.