crmbaseentity EntityType

Article
11/28/2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Description: [No Description]

Display Name: [No Display Name]

Entity types that inherit from crmbaseentity

Operations using the crmbaseentity entity type.

The crmbaseentity entity type has no properties.

The crmbaseentity entity type has no lookup properties.

The crmbaseentity entity type has no single-valued navigation properties.

The crmbaseentity entity type has no collection-valued navigation properties.

Entity types that inherit from crmbaseentity

The following entity types inherit from the crmbaseentity entity type.

Name	Description
account EntityType	Business that represents a customer or potential customer. The company that is billed in business transactions.
actioncard EntityType	Action card entity to show action cards.
actioncarduserstate EntityType
activitymimeattachment EntityType	MIME attachment for an activity.
activityparty EntityType	Person or group associated with an activity. An activity can have multiple activity parties.
activitypointer EntityType	Task performed, or to be performed, by a user. An activity is any action for which an entry can be made on a calendar.
annotation EntityType	Note that is attached to one or more objects, including other notes.
annualfiscalcalendar EntityType	Year long fiscal calendar of an organization. A span of time during which the financial activities of an organization are calculated.
appmoduleroles EntityType	To provide specific CRM UI context .For internal use only
asyncoperation EntityType	Process whose execution can proceed independently or in the background.
attachment EntityType	Attachment for an email activity.
bookableresourcebookingheader EntityType	Reservation entity representing the summary of the associated resource bookings.
bookableresourcebooking EntityType	Represents the line details of a resource booking.
bookableresourcecategory EntityType	Categorize resources that have capacity into categories such as roles.
bookableresourcecategoryassn EntityType	Association entity to model the categorization of resources.
bookableresourcecharacteristic EntityType	Associates resources with their characteristics and specifies the proficiency level of a resource for that characteristic.
bookableresourcegroup EntityType	Associates resources with resource groups that they are a member of.
bookableresource EntityType	Resource that has capacity which can be allocated to work.
bookingstatus EntityType	Allows creation of multiple sub statuses mapped to a booking status option.
bulkdeletefailure EntityType	Record that was not deleted during a bulk deletion job.
bulkdeleteoperation EntityType	User-submitted bulk deletion job.
bulkoperationlog EntityType	Log used to track bulk operation execution, successes, and failures.
businessunitnewsarticle EntityType	Announcement associated with an organization.
businessunit EntityType	Business, division, or department in the Microsoft Dynamics 365 database.
calendarrule EntityType	Defines free/busy times for a service and for resources or resource groups, such as working, non-working, vacation, and blocked.
calendar EntityType	Calendar used by the scheduling system to define when an appointment or activity is to occur.
campaignactivityitem EntityType	Work item of a campaign activity, such as a list or sales literature.
campaignitem EntityType	Work item in a campaign, a list or sales literature.
campaign EntityType	Container for campaign activities and responses, sales literature, products, and lists to create, plan, execute, and track the results of a specific marketing campaign through its life.
category EntityType	Entity for categorizing records to make it easier for your customers to find them on portals and through search.
characteristic EntityType	Skills, education and certifications of resources.
competitoraddress EntityType	Additional addresses for a competitor. The first two addresses are stored in the competitor object.
competitor EntityType	Business competing for the sale represented by a lead or opportunity.
complexcontrol EntityType	For internal use only.
connectionrole EntityType	Role describing a relationship between a two records.
connection EntityType	Relationship between two entities.
constraintbasedgroup EntityType	Group or collection of people, equipment, and/or facilities that can be scheduled.
contact EntityType	Person with whom a business unit has a relationship, such as customer, supplier, and colleague.
contractdetail EntityType	Line item in a contract that specifies the type of service a customer is entitled to.
contract EntityType	Agreement to provide customer service during a specified amount of time or number of cases.
contracttemplate EntityType	Template for a contract containing the standard attributes of a contract.
customcontroldefaultconfig EntityType	For internal use only.
customcontrolresource EntityType	Custom Control Resource Id
customcontrol EntityType	For internal use only.
customeraddress EntityType	Address and shipping information. Used to store additional addresses for an account or contact.
dataperformance EntityType	Data Performance Dashboard.
dependency EntityType	A component dependency in CRM.
discount EntityType	Price reduction made from the list price of a product or service based on the quantity purchased.
discounttype EntityType	Type of discount specified as either a percentage or an amount.
documenttemplate EntityType	Used to store Document Templates in database in binary format.
duplicaterecord EntityType	Potential duplicate record.
duplicaterulecondition EntityType	Condition of a duplicate detection rule.
duplicaterule EntityType	Rule used to identify potential duplicates.
dynamicproperty EntityType	Information about a product property.
dynamicpropertyassociation EntityType	Association of a property definition with another entity in the system.
dynamicpropertyinstance EntityType	Instance of a property with its value.
dynamicpropertyoptionsetitem EntityType	Item with a name and value in a property option set type.
emailserverprofile EntityType	Holds the Email Server Profiles of an organization
entitlementchannel EntityType	Defines the amount and type of support for a channel.
entitlement EntityType	Defines the amount and type of support a customer should receive.
entitlementtemplatechannel EntityType	Contains predefined support terms for a channel to create entitlements for customers.
entitlementtemplate EntityType	Contains predefined customer support terms that can be used to created entitlements for customers.
equipment EntityType	Resource that can be scheduled.
exchangesyncidmapping EntityType	The mapping used to keep track of the IDs for items synced between CRM and Exchange.
expiredprocess EntityType	Expired Process Business Process Flow
feedback EntityType	Container for feedback and ratings for knowledge articles.
fieldpermission EntityType	Group of privileges used to categorize users to provide appropriate access to secured columns.
fieldsecurityprofile EntityType	Profile which defines access level for secured attributes
fixedmonthlyfiscalcalendar EntityType	Fixed monthly fiscal calendar of an organization. A span of time during which the financial activities of an organization are calculated.
goalrollupquery EntityType	Query that is used to filter the results of the goal rollup.
goal EntityType	Target objective for a user or a team for a specified time period.
importdata EntityType	Unprocessed data from imported files.
importentitymapping EntityType	Mapping for entities in a data map.
importfile EntityType	File name of file used for import.
importjob EntityType	For internal use only.
importlog EntityType	Failure reason and other detailed information for a record that failed to import.
importmap EntityType	Data map used in import.
import EntityType	Status and ownership information for an import job.
incident EntityType	Service request case associated with a contract.
interactionforemail EntityType
invaliddependency EntityType	An invalid dependency in the CRM system.
invoicedetail EntityType	Line item in an invoice containing detailed billing information for a product.
invoice EntityType	Order that has been billed.
kbarticlecomment EntityType	Comment on a knowledge base article.
kbarticle EntityType	Structured content that is part of the knowledge base.
kbarticletemplate EntityType	Template for a knowledge base article that contains the standard attributes of an article.
knowledgearticleincident EntityType	Association between an knowledge article and incident.
knowledgearticle EntityType	Organizational knowledge for internal and external use.
knowledgearticleviews EntityType	No of times an article is viewed per day
knowledgebaserecord EntityType	Metadata of knowledge base (KB) articles associated with Microsoft Dynamics 365 entities.
languagelocale EntityType	Language
leadaddress EntityType	Address information for a lead.
lead EntityType	Prospect or potential sales opportunity. Leads are converted into accounts, contacts, or opportunities when they are qualified. Otherwise, they are deleted or archived.
leadtoopportunitysalesprocess EntityType	Lead To Opportunity Sales Process Business Process Flow
listmember EntityType	Item in a marketing list.
list EntityType	Group of existing or potential customers created for a marketing campaign or other sales purposes.
mailbox EntityType
mailmergetemplate EntityType	Template for a mail merge document that contains the standard attributes of that document.
metric EntityType	Type of measurement for a goal, such as money amount or count.
mobileofflineprofileitemassociation EntityType	Information on relationships to be used to follow related entity's records for mobile offline profile item.
mobileofflineprofileitem EntityType	Information on entity availability to mobile devices in offline mode for a mobile offline profile item.
mobileofflineprofile EntityType	Information to administer and manage the data available to mobile devices in offline mode.
monthlyfiscalcalendar EntityType	Monthly fiscal calendar of an organization. A span of time during which the financial activities of an organization are calculated.
newprocess EntityType	New Process Business Process Flow
officegraphdocument EntityType	Office Graph Documents Description
opportunity EntityType	Potential revenue-generating event, or sale to an account, which needs to be tracked through a sales process to completion.
opportunityproduct EntityType	Association between an opportunity and a product.
opportunitysalesprocess EntityType	Opportunity Sales Process Business Process Flow
organization EntityType	Top level of the Microsoft Dynamics 365 business hierarchy. The organization can be a specific business, holding company, or corporation.
principal EntityType	Group of undeleted system users and undeleted teams. Owners can be used to control access to specific objects.
personaldocumenttemplate EntityType	Used to store Personal Document Templates in database in binary format.
phonetocaseprocess EntityType	Phone To Case Process Business Process Flow
pluginassembly EntityType	Assembly that contains one or more plug-in types.
plugintracelog EntityType	Trace and exception information generated by plug-ins and custom workflow activities.
plugintype EntityType	Type that inherits from the IPlugin interface and is contained within a plug-in assembly.
position EntityType	Position of a user in the hierarchy
postcomment EntityType	A comment on an activity feed post.
postfollow EntityType	Represents a user following the activity feed of an object.
postlike EntityType	A like on an activity feed post.
postregarding EntityType	Represents which object an activity feed post is regarding. For internal use only.
post EntityType	An activity feed post.
pricelevel EntityType	Entity that defines pricing levels.
principalobjectaccess EntityType
privilege EntityType	Permission to perform an action in Microsoft CRM. The platform checks for the privilege and rejects the attempt if the user does not hold the privilege.
processstage EntityType	Stage associated with a process.
productassociation EntityType	Instance of a product added to a bundle or kit.
productpricelevel EntityType	Information about how to price a product in the specified price level, including pricing method, rounding option, and discount type based on a specified product unit.
product EntityType	Information about products and their pricing information.
productsubstitute EntityType	Information about the selling relationship between two products, including the relationship type, such as up-sell, cross-sell, substitute, or accessory.
publisheraddress EntityType	Address and shipping information. Used to store additional addresses for a publisher.
publisher EntityType	A publisher of a CRM solution.
quarterlyfiscalcalendar EntityType	Quarterly fiscal calendar of an organization. A span of time during which the financial activities of an organization are calculated.
queueitem EntityType	A specific item in a queue, such as a case record or an activity record.
queue EntityType	A list of records that require action, such as accounts, activities, and cases.
quotedetail EntityType	Product line item in a quote. The details include such information as product ID, description, quantity, and cost.
quote EntityType	Formal offer for products and/or services, proposed at specific prices and related payment terms, which is sent to a prospective customer.
ratingmodel EntityType	Represents a model to evaluate skills or other related entities.
ratingvalue EntityType	A unique value associated with a rating model that allows providing a user friendly rating value.
recommendeddocument EntityType	Document Suggestions
reportcategory EntityType	Categories related to a report. A report can be related to multiple categories.
report EntityType	Data summary in an easy-to-read layout.
resourcegroup EntityType	Resource group or team whose members can be scheduled for a service.
resource EntityType	User or facility/equipment that can be scheduled for a service.
resourcespec EntityType	Selection rule that allows the scheduling engine to select a number of resources from a pool of resources. The rules can be associated with a service.
roleprivileges EntityType	Group of privileges used to categorize users to provide appropriate access to entities.
role EntityType	Grouping of security privileges. Users are assigned roles that authorize their access to the Microsoft CRM system.
roletemplateprivileges EntityType
roletemplate EntityType	Template for a role. Defines initial attributes that will be used when creating a new role.
salesliteratureitem EntityType	Item in the sales literature collection.
salesliterature EntityType	Storage of sales literature, which may contain one or more documents.
salesorderdetail EntityType	Line item in a sales order.
salesorder EntityType	Quote that has been accepted.
savedquery EntityType	Saved query against the database.
savedqueryvisualization EntityType	System chart attached to an entity.
sdkmessagefilter EntityType	Filter that defines which SDK messages are valid for each type of entity.
sdkmessageprocessingstepimage EntityType	Copy of an entity's attributes before or after the core system operation.
sdkmessageprocessingstep EntityType	Stage in the execution pipeline that a plug-in is to execute.
sdkmessageprocessingstepsecureconfig EntityType	Non-public custom configuration that is passed to a plug-in's constructor.
sdkmessage EntityType	Message that is supported by the SDK.
semiannualfiscalcalendar EntityType	Calendar representing the semi-annual span of time during which the financial activities of an organization are calculated.
servicecontractcontacts EntityType
serviceendpoint EntityType	Service endpoint that can be contacted.
service EntityType	Activity that represents work done to satisfy a customer's need.
sharepointdocumentlocation EntityType	Document libraries or folders on a SharePoint server from where documents can be managed in Microsoft Dynamics 365.
sharepointsite EntityType	SharePoint site from where documents can be managed in Microsoft Dynamics 365.
similarityrule EntityType
site EntityType	Location or branch office where an organization does business. An organization can have multiple sites.
slaitem EntityType	Contains information about a tracked support KPI for a specific customer.
slakpiinstance EntityType	Service level agreement (SLA) key performance indicator (KPI) instance that is tracked for an individual case
sla EntityType	Contains information about the tracked service-level KPIs for cases that belong to different customers.
socialprofile EntityType	This entity is used to store social profile information of its associated account and contacts on different social channels.
solutioncomponent EntityType	A component of a CRM solution.
solution EntityType	A solution which contains CRM customizations.
subject EntityType	Information regarding subjects available in the system.
subscriptionmanuallytrackedobject EntityType	For internal use only.
subscriptionstatisticsoffline EntityType	Subscription Statistic Offline
subscriptionstatisticsoutlook EntityType	Subscription Statistic Outlook
subscriptionsyncentryoffline EntityType	Used for offline sync, internal use only.
subscriptionsyncentryoutlook EntityType	Used for outlook sync, internal use only.
syncerror EntityType	Failure reason and other detailed information for a record that failed to sync.
systemform EntityType	Organization-owned entity customizations including form layout and dashboards.
teamtemplate EntityType	Team template for an entity enabled for automatically created access teams.
template EntityType	Template for an email message that contains the standard attributes of an email message.
territory EntityType	Territory represents sales regions.
theme EntityType	Information that's used to set custom visual theme options for client applications.
timestampdatemapping EntityType	For internal use only.`
timezonedefinition EntityType	Time zone definition, including name and time zone code.
timezonelocalizedname EntityType	Localized name of the time zone.
timezonerule EntityType	Definition for time conversion between local time and Coordinated Universal Time (UTC) for a particular time zone at a particular time period.
tracelog EntityType	A trace log.
transactioncurrency EntityType	Currency in which a financial transaction is carried out.
translationprocess EntityType	Translation Process Business Process Flow
uom EntityType	Unit of measure.
uomschedule EntityType	Grouping of units.
userform EntityType	User-owned dashboards.
userquery EntityType	Saved database query that is owned by a user.
userqueryvisualization EntityType	Chart attached to an entity.
usersettings EntityType	User's preferred settings.
webresource EntityType	Data equivalent to files used in Web development. Web resources provide client-side components that are used to provide custom user interface elements.
webwizard EntityType	Definition for a Web-based wizard.
workflowlog EntityType	Log used to track process execution.
workflow EntityType	Set of logical rules that define the steps necessary to automate a specific business process, task, or set of actions to be performed.

Operations using the crmbaseentity entity type.

The following operations use the crmbaseentity entity type in a parameter or return type.

Name	How used	Description
AddItemCampaignActivity Action	Item Parameter	Adds an item to a campaign activity.
AddListMembersList Action	Members Parameter	Adds members to a list.
AddPrincipalToQueue Action	Principal Parameter	Adds the specified principal to the list of queue members.
AddToQueue Action	Target Parameter	Moves an entity record from a source queue to a destination queue.
AddUserToRecordTeam Action	Record Parameter	Adds a user to the auto created access team for the specified record.
ApplyRecordCreationAndUpdateRule Action	Target Parameter	Applies record creation and update rules to activities in 365 created as a result of the integration with external applications.
ApplyRoutingRule Action	Target Parameter	Applies the active routing rule to an incident.
Book Action	Target Parameter	Schedules or "books" an appointment, recurring appointment, or service appointment (service activity).
CalculatePrice Action	Target Parameter	Calculates price in an opportunity, quote, order, and invoice.
CancelSalesOrder Action	OrderClose Parameter	Cancels a sales order.
CompoundUpdateDuplicateDetectionRule Action	Entity Parameter	Updates a duplicate rule (duplicate detection rule) and its related duplicate rule conditions.
CompoundUpdateDuplicateDetectionRule Action	ChildEntities Parameter	Updates a duplicate rule (duplicate detection rule) and its related duplicate rule conditions.
ConvertQuoteToSalesOrder Action	ProcessInstanceId Parameter	Converts a quote to a sales order.
CreateActivitiesList Action	Activity Parameter	Creates a quick campaign to distribute an activity to members of a list (marketing list).
CreateActivitiesList Action	Owner Parameter	Creates a quick campaign to distribute an activity to members of a list (marketing list).
CreateKnowledgeArticleTranslation Action	Source Parameter	Creates translation of a knowledge article instance.
CreateKnowledgeArticleTranslation Action	Language Parameter	Creates translation of a knowledge article instance.
CreateKnowledgeArticleTranslation Action	ReturnType	Creates translation of a knowledge article instance.
CreateKnowledgeArticleVersion Action	Source Parameter	Creates a major or minor version of a knowledge article instance.
CreateKnowledgeArticleVersion Action	ReturnType	Creates a major or minor version of a knowledge article instance.
DistributeCampaignActivity Action	Activity Parameter	Creates a bulk operation that distributes a campaign activity.
DistributeCampaignActivity Action	Owner Parameter	Creates a bulk operation that distributes a campaign activity.
FullTextSearchKnowledgeArticle Action	ReturnType	Performs a full-text search on knowledge articles in Dynamics 365 using the specified search text.
GenerateInvoiceFromOpportunity Action	ReturnType	Generates an invoice from an opportunity.
GenerateQuoteFromOpportunity Action	ReturnType	Generates a quote from an opportunity.
GenerateSalesOrderFromOpportunity Action	ReturnType	Generates a sales order (order) from an opportunity.
InstantiateTemplate Action	ReturnType	Creates an email message from a template (email template).
Merge Action	Target Parameter	Merges the information from two entity records of the same type.
Merge Action	Subordinate Parameter	Merges the information from two entity records of the same type.
Merge Action	UpdateContent Parameter	Merges the information from two entity records of the same type.
PropagateByExpression Action	Activity Parameter	Creates a quick campaign to distribute an activity to accounts, contacts, or leads that are selected by a query.
PropagateByExpression Action	Owner Parameter	Creates a quick campaign to distribute an activity to accounts, contacts, or leads that are selected by a query.
QualifyLead Action	OpportunityCustomerId Parameter	Qualifies a lead and create account, contact, and opportunity records that are linked to the originating lead record.
QualifyLead Action	ProcessInstanceId Parameter	Qualifies a lead and create account, contact, and opportunity records that are linked to the originating lead record.
QualifyLead Action	ReturnType	Qualifies a lead and create account, contact, and opportunity records that are linked to the originating lead record.
QualifyMemberList Action	ListMember Parameter	Qualifies the specified list and either override the list members or remove them according to the specified option.
ReassignObjectsOwner Action	FromPrincipal Parameter	Reassigns all records that are owned by the security principal (user or team) to another security principal (user or team).
ReassignObjectsOwner Action	ToPrincipal Parameter	Reassigns all records that are owned by the security principal (user or team) to another security principal (user or team).
ReassignObjectsSystemUser Action	ReassignPrincipal Parameter	Reassigns all records that are owned by a specified user to another security principal (user or team).
RemoveParent Action	Target Parameter	Removes the parent for a system user (user) record.
RemoveUserFromRecordTeam Action	Record Parameter	Removes a user from the auto created access team for the specified record.
Reschedule Action	Target Parameter	Reschedules an appointment, recurring appointment, or service appointment (service activity).
RevertProduct Action	Target Parameter	Reverts changes done to properties of a product family, product, or bundle record, and set it back to its last published (active) state.
RevokeAccess Action	Target Parameter	Replaces the access rights on the target record for the specified security principal (user or team).
RevokeAccess Action	Revokee Parameter	Replaces the access rights on the target record for the specified security principal (user or team).
RouteTo Action	Target Parameter	Routes a queue item to a queue, a user, or a team.
SendBulkMail Action	Sender Parameter	Sends bulk email messages.
SendEmailFromTemplate Action	Regarding Parameter	Sends an e-mail message to a recipient using an e-mail template.
SendEmailFromTemplate Action	Target Parameter	Sends an e-mail message to a recipient using an e-mail template.
SendTemplate Action	Sender Parameter	Sends a bulk email message that is created from a template.
SendTemplate Action	Recipients Parameter	Sends a bulk email message that is created from a template.
SendTemplate Action	Regarding Parameter	Sends a bulk email message that is created from a template.
SetBusinessSystemUser Action	ReassignPrincipal Parameter	Moves a system user (user) to a different business unit.
SetLocLabels Action	EntityMoniker Parameter	Sets localized labels for a limited set of entity attributes.
SetProcess Action	Target Parameter	Sets the process that associates with a given target entity. The user can set to another business process or specify null to clear out the current process.
SetProcess Action	NewProcess Parameter	Sets the process that associates with a given target entity. The user can set to another business process or specify null to clear out the current process.
SetProcess Action	NewProcessInstance Parameter	Sets the process that associates with a given target entity. The user can set to another business process or specify null to clear out the current process.
CalculateRollupField Function	Target Parameter	Calculates the value of a rollup attribute.
CalculateRollupField Function	ReturnType	Calculates the value of a rollup attribute.
GetAllTimeZonesWithDisplayName Function	ReturnType	Retrieves all the time zone definitions for the specified locale and to return only the display name attribute.
IncrementKnowledgeArticleViewCount Function	Source Parameter	Increments the per day view count of a knowledge article record.
IncrementKnowledgeArticleViewCount Function	ReturnType	Increments the per day view count of a knowledge article record.
InitializeFrom Function	EntityMoniker Parameter	Initializes a new record from an existing record.
InitializeFrom Function	ReturnType	Initializes a new record from an existing record.
IsValidStateTransition Function	Entity Parameter	Validates the state transition.
RetrieveDuplicates Function	BusinessEntity Parameter	Detects and retrieves duplicates for a specified record.
RetrieveDuplicates Function	ReturnType	Detects and retrieves duplicates for a specified record.
RetrieveExchangeAppointments Function	ReturnType	Retrieves the appointments for the current user for a specific date range from the exchange web service.
RetrieveLocLabels Function	EntityMoniker Parameter	Retrieves localized labels for a limited set of entity attributes.
RetrieveMembersBulkOperation Function	ReturnType	Retrieves the members of a bulk operation.
RetrieveMissingDependencies Function	ReturnType	Retrieves any required solution components that are not included in the solution.
RetrievePrincipalAccess Function	Target Parameter	Retrieves the access rights of the specified security principal (team or user) to the specified record.
RetrieveProcessInstances Function	ReturnType	TODO: RetrieveProcessInstances Function Description
RetrieveRecordWall Function	Entity Parameter	Retrieves pages of posts, including comments for each post, for a specified record.
RetrieveRequiredComponents Function	ReturnType	Retrieves a collection of solution components that are required for a solution component.
Rollup Function	Target Parameter	Retrieves all the entity records that are related to the specified record.
Rollup Function	ReturnType	Retrieves all the entity records that are related to the specified record.
ValidateRecurrenceRule Function	Target Parameter	Validates a rule for a recurring appointment.

crmbaseentity EntityType

Entity types that inherit from crmbaseentity

Operations using the crmbaseentity entity type.

See Also

Additional resources