--- schema_version: "1" id: 2693c30cfb95c72ff82827124dc54bdcfacda17db20a730b5c483320634eb5f6 title: Referral collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/financial_services_cloud_object_reference/fsc_sforce_api_objects_referral.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/fsc_sforce_api_objects_referral.htm source_site: developer.salesforce.com content_type: documentation content_hash: 5c995b59617ac361fd0d73a4c5f0754257b774dfe4535d6cf7bc9b1e2aa62a49 description: Represents the information on referrals in an organization. This object is available in API version 66.0 and later. --- # Referral Represents the information on referrals in an organization. This object is available in API version 66.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert() ## Special Access Rules This object is available only to users with the FSCReferralUser permission set license on the Financial Services Cloud standard data model. ## Fields ### 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. ## 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. [ReferralChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object. [ReferralFeed](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [ReferralHistory](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [ReferralOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [ReferralShare](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object.