Referral resources
Article 11/12/2024
7 contributors
Feedback
In this article
Applies to:
These resources represent a sales lead direct from a customer, Microsoft, or another partner.
Referral
Represents the referral.
Property
Type
Description
ID
string
The ID for this Referral.
EngagementID
string
The EngagementID for this Referral. Multiple referrals can be associated to a single EngagementID
Name
string
The name of the Referral.
ExternalReferenceID
string
An external identifier for the referral. Example: Store your own Dynamics 365 lead/opportunity ID
CreatedDateTime
string in UTC date time format
The date the referral was created.
UpdatedDateTime
string in UTC date time format
The date the referral was last updated.
ExpirationDateTime
string in UTC date time format
The date the referral expires.
AcceptedDateTime
string in UTC date time format
The date partner accepted the referral. For outgoing referrals, it's same date as referral creation datetime.
Status
ReferralStatus An Enum with values that indicate the referral status.
Substatus
ReferralSubstatus An Enum with values that indicate the referral sub status.
StatusReason
string
A descriptive message about the status. Example: Why was the referral lost?
Type
ReferralType Represents the referral type.
Qualification
ReferralQualification Represents the quality of the referral.
ReferralSource
ReferralSource Represents source of Marketplace lead
CallToAction
CallToAction Represents call to action for a Marketplace lead
CustomerProfile
CustomerProfile Information about the customer.
Consent
Consent Consent flags around sharing information with other organizations and allowing them to contact users.
Details
ReferralDetails Customer details, notes, deal value, currency closing date.
Team
Member Represents users in the organizations that are involved.
InviteContext
InviteContext Represents more information a user can provide when inviting another organization into the partner engagement.
ETag
string
ETags are used and required for concurrency checking when updating resources.
Target
ReferralTarget Represents more information a user can provide when inviting another organization into the partner engagement.
MpnId
numeric string
Represent a Partner ID that identifies the partner.
ReferralStatus
An Enum with values that indicate the referral status.
Value
Description
None
New
Represents a new referral.
Active
Represents an active referral.
Closed
Represents a closed referral.
ReferralSubstatus
An Enum with values that indicate the referral status.
Value
Description
None
Pending
Represents a new referral that is pending.
Received
Represents a new referral that was received.
Accepted
Represents an active referral that was accepted.
Won
Represents a closed referral that was won.
Lost
Represents a closed referral that was lost.
Declined
Represents a closed referral that was declined.
Expired
Represents a closed referral that was expired.
Error
Represents a closed referral marked as error.
Status transition & Substatus states
Status
Allowed Status Transition
Allowed Substatus
New
New, Active, Closed
Pending, Received
Active
Active, Closed
Accepted
Closed
Closed
Won, Lost, Declined, Expired, Error
ReferralType
An Enum with values that indicate the referral type.
Property
Description
Shared
Represents a referral in which all parties involved collaborate to close.
Independent
Represents a referral in which two parties collaborate to close.
ReferralQualification
An Enum with values that indicate the referral status.
Value
Description
None
Represents a referral that has no quality measure associated.
Direct
Represents a referral that a customer created directly.
MarketingQualified
Represents a referral that was generated via Microsoft marketing automation systems.
SalesQualified
Represents a referral from a Microsoft sales agent.
Referralsource
An Enum with values that indicate source of the Marketplace lead.
Value
AppSource
AzureMarketplace
AzurePortal
PowerBI
CallToAction
An Enum with values that indicate call to action for the Marketplace lead.
Value
ContactMe
FreeTrial
GetItNow
CustomerProfile
Contains the customer contact information.
Property
Type
Description
Name
string
The customer organization name.
Address
Address The address of the customer.
Size
string
The number of employees at the customer's organization.
Team
Member The contacts for the customer's organization.
IDs
CustomerProfileType An Array of values that indicate External IDs for the customer.
CustomerProfileType
Contains the External IDs for the customer.
Property
Type
Description
Duns
string
The Dun & Bradstreet number for the customer.
External
string
A customer ID unique to your organization.
Address
An address to use for the customer.
Property
Type
Description
AddressLine1
string
The first line of the address.
AddressLine2
string
The second line of the address. This property is optional.
City
string
The city.
State
string
The state.
PostalCode
string
The zip code or postal code
Country
string
The country/region in ISO 3166 2-letter country code format .
Region
string
The region.
Member
Describes contact information for a specific individual.
Property
Type
Description
FirstName
string
The contact's first name.
LastName
string
The contact's surname.
PhoneNumber
string
The contact's phone number.
Email
string
The contact's email address.
ContactPreference
ContactPreference The contact's preference for receiving email notifications.
Describes contact preferences for receiving email notifications.
Property
Type
Description
Locale
string
The locale of the email notification. AllCultures , NeutralCultures , and SpecificCultures are supported
DisableNotifications
bool
Disables email notifications for the user.
Consent
Consent flags around sharing information with other organizations and allowing them to contact users.
Property
Type
Description
ConsentToToShareInfoWithOthers
boolean
Indicates consent to share personal data with others.
ConsentToContact
boolean
Indicates consent to contact users.
ConsentToShareReferralWithMicrosoftSellers
boolean
Indicates consent to share the deal with Microsoft sellers.
ConsentToMicrosoftToContactSpecificPartners
boolean
Indicates consent to let Microsoft contact specific partners for this deal.
InviteContext
More information that can be shared when inviting another organization.
Property
Type
Description
Notes
string
More notes for the receiving organization.
InvitedBy
InvitedBy The organization ID that sent the referral.
InvitedBy
More information that can be shared when inviting another organization.
Property
Type
Description
OrganizationID
string
The organization ID that sent the referral.
OrganizationName
string
The organization name that sent the referral.
ReferralDetails
Represents the referral details.
Property
Type
Description
Notes
string
More notes for the receiving organization.
DealValue
decimal
Value of the referral.
Currency
string
The ISO 4217 currency symbol
ClosingDateTime
string in UTC date time format
Date the customer is looking to close by.
Requirements
ReferralRequirements Industry, products, service type, and solutions the customer is interested in.
ReferralRequirements
Contains the customer requirements.
Property
Type
Description
Industries
Tag The industries the customer is interested in.
Products
Tag The products the customer is interested in.
Services
Tag The services the customer is interested in.
Solutions
SolutionTag The solutions the customer is interested in.
Offers
OfferTag The offers the customer is interested in.
AdditionalRequirements
AdditionalRequirements Other attributes in referral requirements.
SolutionTag
Contains the solution details.
Property
Type
Description
ID
string
The ID of the solution.
Name
string
The name of the solution.
Type
SolutionType The type of solution.
SolutionType
string
Possible types are 1P, 3P, and SA.
Price
string
The price of the solution.
Currency
string
The currency of the solution. The ISO 4217 currency symbol .
Quantity
number
The quantity of the solution.
PublisherName
string
The solution publisher's organization name.
SolutionType
An Enum with values that indicate the solution type.
Property
Description
None
Category
Uses predefined solution names.
Name
Ability to reference solutions from the Microsoft catalog.
OfferTag
Contains the offer details.
Property
Type
Description
ID
string
The ID of the offer.
Name
string
The name of the offer.
Type
SolutionType The type of offer.
OfferType
string
Possible types are 1P, 3P, and SA.
PublisherName
string
The offer publisher's organization name.
AdditionalRequirements
Contains other attributes in referral requirements.
Property
Type
Description
Iot
IoTRequirements Describes IoT requirements for an IoT deal.
Attributes
AttributeTag List of other attributes in the referral.
IoTRequirements
Describes the OEM IoT requirements.
Property
Type
Description
CustomerLicenseAgreementNumber
string
Customer license agreement between partner and customer for OEM IoT deals.
DeviceCategory
string
The device category for the OEM IoT devices.
SiliconType
string
The CPU type for the OEM IoT devices.
AzureCertifiedDevice
boolean
Indicates if the device is Azure Certified and will work well with Azure.
AttachServices
boolean
Indicates if partners are adding any add-on service apart from the solution in the deal.
AttributeTag
Describes the attribute tag.
Property
Type
Description
ID
string
Indicates the associated value of the attribute.
Type
string
Indicates attribute property type, for example, CustomerMarketplaceIntent
CustomerMarketplaceIntent
An Enum with values that indicate the customer's purchase intent on Microsoft marketplace.
Note
In API requests, CustomerMarketplaceIntent is set into AdditionalRequirements as attribute , where Type : "CustomerMarketplaceIntent", and ID as the enum value.
Property
Description
Yes
Customer has intent to transact on Microsoft marketplace.
No
Customer has no intent to transact on Microsoft marketplace.
HaveNotDecided
Customer yet to decide on intent to transact on Microsoft marketplace.
Target
Describes the Referral Target.
Property
Type
Description
ID
string
The ID of the referral target.
Type
ReferralTargetType Referral target type
TargetType
An Enum with values that indicate the solution type.
Property
Description
None
BusinessProfileLocation
Profile location from the partner business profile.
SolutionProfile
Solution profile of the partner.
Tag
Describes the tag.
Property
Type
Description
ID
string
The ID for this tag.
Products
Value
Azure
EnterpriseMobilityAndSecurity
Exchange
DeveloperTools
Dynamics365Business
Dynamics365Enterprise
DynamicsAX,GP,NAV,SL
Microsoft365
Office
PowerBI
Project
SharePoint
SkypeForBusiness
Surface
SurfaceHub
SQL
Teams
Visio
Windows
Yammer
Services
Value
ConsultingAndProfessional
CustomSolution(ISV)
DeploymentOrMigration
Hardware
Integration
IPServices(ISV)
LearningAndCertification
Licensing
ManagedServices
ProjectServices
Industries
Value
Agriculture, Forestry, & Fishing
Communications & Media
Education
Financial Services
Government
Healthcare
Hospitality
Manufacturing
Power & Utilities
Public Safety and National Security
Retail & Consumer Goods
Services
Travel & Transportation
Wholesale & Distribution
Solutions
Value
AdvancedAnalytics
ApplicationIntegration
ArtificialIntelligence
AzureSecurityOperationManagement
AzureStack
BackupDisasterRecovery
BigData
Blockchain
Chatbot
CloudDatabaseMigration
CloudMigration
CloudVoice
CognitiveServices
CompetitiveDatabaseMigration
Containers
DataWarehouse
DatabaseonLinux
DevelopmentandTest
DevOps
DigitalMedia
Dynamics365forCustomerService
Dynamics365forFieldService
Dynamics365forFinanceOperations
Dynamics365forRetail
Dynamics365forSales
Dynamics365forTalent
DynamicsonAzure
EnterpriseBusinessIntelligence
Gaming
HighPerformanceComputing
HybridStorage
IdentityandAccessManagement
InformationManagement
InternetofThings
MachineLearning
Microserviceapplications
MobileApplications
MySQLPostgresMigrationtoAzure
Networking
NoSQLMigration
RedhatonAzure
RegulatoryComplianceGDPR
SAPonAzure
ServerlessComputing
SharepointonAzure
SQLServerUpgrade
ThreatProtection
WebDevelopment
Customer Size
Value
1to50employees
51to500employees
Morethan500employees
1to9employees
10to50employees
51to250employees
251to1000employees
1001to5000employees
5001to10000employees
10001to20000employees
Morethan20000employees
PartnerRole
Value
Adoption and change management
Business strategy
Deployment services
Managed services
Presales envisioning
Proof of concept
Solution design
Transaction
SolutionArea
The following table shows the values for Solution Area and Solution Play fields for FY 25.
Solution Area
Solution Play
Business Applications
Accelerate Revenue Generation
Business Applications
AI Powered Business with Copilot
Business Applications
Connected Sales and Marketing
Business Applications
Drive Business Transformation with Copilot
Business Applications
Enable a Resilient and Sustainable Supply Chain
Business Applications
Innovate with AI in Low Code
Business Applications
Modernize ERP
Business Applications
Modernize Service
Business Applications
Modernize the Service Experience
Business Applications
Optimize Finance and Supply Chain
Business Applications
Scale Business Operations
Data and AI
Advance Sustainability with an Intelligent Data Platform
Data and AI
Build and Modernize AI Apps
Data and AI
Data Security
Data and AI
Enable Unified Data Governance
Data and AI
Innovate with AI and Cloud Scale Databases in Every App
Data and AI
Innovate with Azure AI Platform
Data and AI
Migrate and Modernize Your Data Estate
Data and AI
Migrate and Secure Windows Server SQL and Linux Estate
Data and AI
Migrate Oracle
Data and AI
Unify Your Intelligent Data and Analytics Platform
Digital and Application Innovation
Accelerate Developer Productivity
Digital and Application Innovation
Accelerate Innovation with Integration Services
Digital and Application Innovation
Accelerate Innovation with Low Code
Digital and Application Innovation
Build and Modernize AI Apps
Digital and Application Innovation
Build your Games in the Cloud with Azure
Digital and Application Innovation
Enable Developer Productivity and Accelerate Delivery
Digital and Application Innovation
Innovate and Scale with Cloud Native Apps
Digital and Application Innovation
Migrate Enterprise Apps
Digital and Application Innovation
Modernize Enterprise Applications
Infrastructure
Enable Customer Success
Infrastructure
Innovate Across Hybrid and Edge with Arc and IoT
Infrastructure
Innovate with Azure AI Platform
Infrastructure
Innovate with HPC
Infrastructure
MACC Accelerate Growth with Microsoft Azure Consumption Commitments
Infrastructure
Migrate and Modernize your Infrastructure and Workloads
Infrastructure
Migrate and Secure Windows Server SQL and Linux Estate
Infrastructure
Migrate Linux Estate
Infrastructure
Migrate Oracle
Infrastructure
Migrate SAP
Infrastructure
Modernize SAP on the Microsoft Cloud
Infrastructure
Modernize your Workloads with Azure at any Scale with HPC plus AI
Infrastructure
Modernizing Mainframe
Infrastructure
Protect your Data and Ensure Business Resiliency with BCDR
Modern Work
AI Powered Business with Copilot
Modern Work
Cloud Endpoints
Modern Work
Collaborative Apps
Modern Work
Converged Communications
Modern Work
Converged Communications Teams Phone
Modern Work
Converged Communications Teams Rooms
Modern Work
Data Security
Modern Work
Digital Workforce
Modern Work
Drive Business Transformation with Copilot
Modern Work
Employee Experience
Modern Work
Frontline Workers
Modern Work
Modernize with Surface
Modern Work
NextGen Windows Experiences
Modern Work
Refresh your Devices
Modern Work
Secure Productivity
Security
Advanced Identity
Security
Copilot for Security
Security
Data Governance
Security
Data Security
Security
Defend Against Threats with SIEM Plus XDR
Security
Migrate and Secure Windows Server SQL and Linux Estate
Security
Mitigate Compliance and Privacy Risks
Security
Modern Sec Ops
Security
Multi Cloud Security
Security
Protect and Govern Sensitive Data
Security
Secure Identities and Access
Security
Secure Multi Cloud Environments
Security
Secure Productivity
Security
Threat protection
Unified Support
Accelerate AI innovation for Digital Natives with Unified
Unified Support
Build a Strong Foundation with Unified
Unified Support
Drive Cloud Success with Enhanced Solutions
Unified Support
Scale Unified through Partner
Related content