account EntityType

Business that represents a customer or potential customer. The company that is billed in business transactions.

Entity Set Path
[organization URI]/api/data/v9.0/accounts
Base Type
crmbaseentity
Display Name
Account
Primary Key
accountid
Primary Key Attribute
name
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
accountcategorycode Edm.Int32

Select a category to indicate whether the customer account is standard or preferred.

Display Name: Category

Default Options
Value Label
1 Preferred Customer
2 Standard
accountclassificationcode Edm.Int32

Select a classification code to indicate the potential value of the customer account based on the projected return on investment, cooperation level, sales cycle length or other criteria.

Display Name: Classification

Default Options
Value Label
1 Default Value
accountid Edm.Guid

Unique identifier of the account.

Display Name: Account

accountnumber Edm.String

Type an ID number or code for the account to quickly search and identify the account in system views.

Display Name: Account Number

accountratingcode Edm.Int32

Select a rating to indicate the value of the customer account.

Display Name: Account Rating

Default Options
Value Label
1 Default Value
address1_addressid Edm.Guid

Unique identifier for address 1.

Display Name: Address 1: ID

address1_addresstypecode Edm.Int32

Select the primary address type.

Display Name: Address 1: Address Type

Default Options
Value Label
1 Bill To
2 Ship To
3 Primary
4 Other
address1_city Edm.String

Type the city for the primary address.

Display Name: Address 1: City

address1_composite Edm.String

Shows the complete primary address.

Display Name: Address 1

Read Only
address1_country Edm.String

Type the country or region for the primary address.

Display Name: Address 1: Country/Region

address1_county Edm.String

Type the county for the primary address.

Display Name: Address 1: County

address1_fax Edm.String

Type the fax number associated with the primary address.

Display Name: Address 1: Fax

address1_freighttermscode Edm.Int32

Select the freight terms for the primary address to make sure shipping orders are processed correctly.

Display Name: Address 1: Freight Terms

Default Options
Value Label
1 FOB
2 No Charge
address1_latitude Edm.Double

Type the latitude value for the primary address for use in mapping and other applications.

Display Name: Address 1: Latitude

address1_line1 Edm.String

Type the first line of the primary address.

Display Name: Address 1: Street 1

address1_line2 Edm.String

Type the second line of the primary address.

Display Name: Address 1: Street 2

address1_line3 Edm.String

Type the third line of the primary address.

Display Name: Address 1: Street 3

address1_longitude Edm.Double

Type the longitude value for the primary address for use in mapping and other applications.

Display Name: Address 1: Longitude

address1_name Edm.String

Type a descriptive name for the primary address, such as Corporate Headquarters.

Display Name: Address 1: Name

address1_postalcode Edm.String

Type the ZIP Code or postal code for the primary address.

Display Name: Address 1: ZIP/Postal Code

address1_postofficebox Edm.String

Type the post office box number of the primary address.

Display Name: Address 1: Post Office Box

address1_primarycontactname Edm.String

Type the name of the main contact at the account's primary address.

Display Name: Address 1: Primary Contact Name

address1_shippingmethodcode Edm.Int32

Select a shipping method for deliveries sent to this address.

Display Name: Address 1: Shipping Method

Default Options
Value Label
1 Airborne
2 DHL
3 FedEx
4 UPS
5 Postal Mail
6 Full Load
7 Will Call
address1_stateorprovince Edm.String

Type the state or province of the primary address.

Display Name: Address 1: State/Province

address1_telephone1 Edm.String

Type the main phone number associated with the primary address.

Display Name: Address Phone

address1_telephone2 Edm.String

Type a second phone number associated with the primary address.

Display Name: Address 1: Telephone 2

address1_telephone3 Edm.String

Type a third phone number associated with the primary address.

Display Name: Address 1: Telephone 3

address1_upszone Edm.String

Type the UPS zone of the primary address to make sure shipping charges are calculated correctly and deliveries are made promptly, if shipped by UPS.

Display Name: Address 1: UPS Zone

address1_utcoffset Edm.Int32

Select the time zone, or UTC offset, for this address so that other people can reference it when they contact someone at this address.

Display Name: Address 1: UTC Offset

address2_addressid Edm.Guid

Unique identifier for address 2.

Display Name: Address 2: ID

address2_addresstypecode Edm.Int32

Select the secondary address type.

Display Name: Address 2: Address Type

Default Options
Value Label
1 Default Value
address2_city Edm.String

Type the city for the secondary address.

Display Name: Address 2: City

address2_composite Edm.String

Shows the complete secondary address.

Display Name: Address 2

Read Only
address2_country Edm.String

Type the country or region for the secondary address.

Display Name: Address 2: Country/Region

address2_county Edm.String

Type the county for the secondary address.

Display Name: Address 2: County

address2_fax Edm.String

Type the fax number associated with the secondary address.

Display Name: Address 2: Fax

address2_freighttermscode Edm.Int32

Select the freight terms for the secondary address to make sure shipping orders are processed correctly.

Display Name: Address 2: Freight Terms

Default Options
Value Label
1 Default Value
address2_latitude Edm.Double

Type the latitude value for the secondary address for use in mapping and other applications.

Display Name: Address 2: Latitude

address2_line1 Edm.String

Type the first line of the secondary address.

Display Name: Address 2: Street 1

address2_line2 Edm.String

Type the second line of the secondary address.

Display Name: Address 2: Street 2

address2_line3 Edm.String

Type the third line of the secondary address.

Display Name: Address 2: Street 3

address2_longitude Edm.Double

Type the longitude value for the secondary address for use in mapping and other applications.

Display Name: Address 2: Longitude

address2_name Edm.String

Type a descriptive name for the secondary address, such as Corporate Headquarters.

Display Name: Address 2: Name

address2_postalcode Edm.String

Type the ZIP Code or postal code for the secondary address.

Display Name: Address 2: ZIP/Postal Code

address2_postofficebox Edm.String

Type the post office box number of the secondary address.

Display Name: Address 2: Post Office Box

address2_primarycontactname Edm.String

Type the name of the main contact at the account's secondary address.

Display Name: Address 2: Primary Contact Name

address2_shippingmethodcode Edm.Int32

Select a shipping method for deliveries sent to this address.

Display Name: Address 2: Shipping Method

Default Options
Value Label
1 Default Value
address2_stateorprovince Edm.String

Type the state or province of the secondary address.

Display Name: Address 2: State/Province

address2_telephone1 Edm.String

Type the main phone number associated with the secondary address.

Display Name: Address 2: Telephone 1

address2_telephone2 Edm.String

Type a second phone number associated with the secondary address.

Display Name: Address 2: Telephone 2

address2_telephone3 Edm.String

Type a third phone number associated with the secondary address.

Display Name: Address 2: Telephone 3

address2_upszone Edm.String

Type the UPS zone of the secondary address to make sure shipping charges are calculated correctly and deliveries are made promptly, if shipped by UPS.

Display Name: Address 2: UPS Zone

address2_utcoffset Edm.Int32

Select the time zone, or UTC offset, for this address so that other people can reference it when they contact someone at this address.

Display Name: Address 2: UTC Offset

aging30 Edm.Decimal

For system use only.

Display Name: Aging 30

Read Only
aging30_base Edm.Decimal

The base currency equivalent of the aging 30 field.

Display Name: Aging 30 (Base)

Read Only
aging60 Edm.Decimal

For system use only.

Display Name: Aging 60

Read Only
aging60_base Edm.Decimal

The base currency equivalent of the aging 60 field.

Display Name: Aging 60 (Base)

Read Only
aging90 Edm.Decimal

For system use only.

Display Name: Aging 90

Read Only
aging90_base Edm.Decimal

The base currency equivalent of the aging 90 field.

Display Name: Aging 90 (Base)

Read Only
businesstypecode Edm.Int32

Select the legal designation or other business type of the account for contracts or reporting purposes.

Display Name: Business Type

Default Options
Value Label
1 Default Value
createdon Edm.DateTimeOffset

Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Created On

Read Only
creditlimit Edm.Decimal

Type the credit limit of the account. This is a useful reference when you address invoice and accounting issues with the customer.

Display Name: Credit Limit

creditlimit_base Edm.Decimal

Shows the credit limit converted to the system's default base currency for reporting purposes.

Display Name: Credit Limit (Base)

Read Only
creditonhold Edm.Boolean

Select whether the credit for the account is on hold. This is a useful reference while addressing the invoice and accounting issues with the customer.

Display Name: Credit Hold

Default Options
Value Label
1 Yes
0 No
customersizecode Edm.Int32

Select the size category or range of the account for segmentation and reporting purposes.

Display Name: Customer Size

Default Options
Value Label
1 Default Value
customertypecode Edm.Int32

Select the category that best describes the relationship between the account and your organization.

Display Name: Relationship Type

Default Options
Value Label
1 Competitor
2 Consultant
3 Customer
4 Investor
5 Partner
6 Influencer
7 Press
8 Prospect
9 Reseller
10 Supplier
11 Vendor
12 Other
description Edm.String

Type additional information to describe the account, such as an excerpt from the company's website.

Display Name: Description

donotbulkemail Edm.Boolean

Select whether the account allows bulk email sent through campaigns. If Do Not Allow is selected, the account can be added to marketing lists, but is excluded from email.

Display Name: Do not allow Bulk Emails

Default Options
Value Label
1 Do Not Allow
0 Allow
donotbulkpostalmail Edm.Boolean

Select whether the account allows bulk postal mail sent through marketing campaigns or quick campaigns. If Do Not Allow is selected, the account can be added to marketing lists, but will be excluded from the postal mail.

Display Name: Do not allow Bulk Mails

Default Options
Value Label
1 Yes
0 No
donotemail Edm.Boolean

Select whether the account allows direct email sent from Microsoft Dynamics 365.

Display Name: Do not allow Emails

Default Options
Value Label
1 Do Not Allow
0 Allow
donotfax Edm.Boolean

Select whether the account allows faxes. If Do Not Allow is selected, the account will be excluded from fax activities distributed in marketing campaigns.

Display Name: Do not allow Faxes

Default Options
Value Label
1 Do Not Allow
0 Allow
donotphone Edm.Boolean

Select whether the account allows phone calls. If Do Not Allow is selected, the account will be excluded from phone call activities distributed in marketing campaigns.

Display Name: Do not allow Phone Calls

Default Options
Value Label
1 Do Not Allow
0 Allow
donotpostalmail Edm.Boolean

Select whether the account allows direct mail. If Do Not Allow is selected, the account will be excluded from letter activities distributed in marketing campaigns.

Display Name: Do not allow Mails

Default Options
Value Label
1 Do Not Allow
0 Allow
donotsendmm Edm.Boolean

Select whether the account accepts marketing materials, such as brochures or catalogs.

Display Name: Send Marketing Materials

Default Options
Value Label
1 Do Not Send
0 Send
emailaddress1 Edm.String

Type the primary email address for the account.

Display Name: Email

emailaddress2 Edm.String

Type the secondary email address for the account.

Display Name: Email Address 2

emailaddress3 Edm.String

Type an alternate email address for the account.

Display Name: Email Address 3

entityimage Edm.Binary

Shows the default image for the record.

Display Name: Default Image

entityimage_timestamp Edm.Int64
Read Only
entityimage_url Edm.String
Read Only
entityimageid Edm.Guid

For internal use only.

Display Name: Entity Image Id

Read Only
exchangerate Edm.Decimal

Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency.

Display Name: Exchange Rate

Read Only
fax Edm.String

Type the fax number for the account.

Display Name: Fax

followemail Edm.Boolean

Information about whether to allow following email activity like opens, attachment views and link clicks for emails sent to the account.

Display Name: Follow Email Activity

Default Options
Value Label
1 Allow
0 Do Not Allow
ftpsiteurl Edm.String

Type the URL for the account's FTP site to enable users to access data and share documents.

Display Name: FTP Site

importsequencenumber Edm.Int32

Unique identifier of the data import or data migration that created this record.

Display Name: Import Sequence Number

industrycode Edm.Int32

Select the account's primary industry for use in marketing segmentation and demographic analysis.

Display Name: Industry

Default Options
Value Label
1 Accounting
2 Agriculture and Non-petrol Natural Resource Extraction
3 Broadcasting Printing and Publishing
4 Brokers
5 Building Supply Retail
6 Business Services
7 Consulting
8 Consumer Services
9 Design, Direction and Creative Management
10 Distributors, Dispatchers and Processors
11 Doctor's Offices and Clinics
12 Durable Manufacturing
13 Eating and Drinking Places
14 Entertainment Retail
15 Equipment Rental and Leasing
16 Financial
17 Food and Tobacco Processing
18 Inbound Capital Intensive Processing
19 Inbound Repair and Services
20 Insurance
21 Legal Services
22 Non-Durable Merchandise Retail
23 Outbound Consumer Service
24 Petrochemical Extraction and Distribution
25 Service Retail
26 SIG Affiliations
27 Social Services
28 Special Outbound Trade Contractors
29 Specialty Realty
30 Transportation
31 Utility Creation and Distribution
32 Vehicle Retail
33 Wholesale
lastonholdtime Edm.DateTimeOffset

Contains the date and time stamp of the last on hold time.

Display Name: Last On Hold Time

lastusedincampaign Edm.DateTimeOffset

Shows the date when the account was last included in a marketing campaign or quick campaign.

Display Name: Last Date Included in Campaign

marketcap Edm.Decimal

Type the market capitalization of the account to identify the company's equity, used as an indicator in financial performance analysis.

Display Name: Market Capitalization

marketcap_base Edm.Decimal

Shows the market capitalization converted to the system's default base currency.

Display Name: Market Capitalization (Base)

Read Only
marketingonly Edm.Boolean

Whether is only for marketing

Display Name: Marketing Only

Default Options
Value Label
1 Yes
0 No
merged Edm.Boolean

Shows whether the account has been merged with another account.

Display Name: Merged

Read Only
Default Options
Value Label
1 Yes
0 No
modifiedon Edm.DateTimeOffset

Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.

Display Name: Modified On

Read Only
name Edm.String

Type the company or business name.

Display Name: Account Name

numberofemployees Edm.Int32

Type the number of employees that work at the account for use in marketing segmentation and demographic analysis.

Display Name: Number of Employees

onholdtime Edm.Int32

Shows how long, in minutes, that the record was on hold.

Display Name: On Hold Time (Minutes)

Read Only
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

ownershipcode Edm.Int32

Select the account's ownership structure, such as public or private.

Display Name: Ownership

Default Options
Value Label
1 Public
2 Private
3 Subsidiary
4 Other
participatesinworkflow Edm.Boolean

For system use only. Legacy Microsoft Dynamics CRM 3.0 workflow data.

Display Name: Participates in Workflow

Default Options
Value Label
1 Yes
0 No
paymenttermscode Edm.Int32

Select the payment terms to indicate when the customer needs to pay the total amount.

Display Name: Payment Terms

Default Options
Value Label
1 Net 30
2 2% 10, Net 30
3 Net 45
4 Net 60
preferredappointmentdaycode Edm.Int32

Select the preferred day of the week for service appointments.

Display Name: Preferred Day

Default Options
Value Label
0 Sunday
1 Monday
2 Tuesday
3 Wednesday
4 Thursday
5 Friday
6 Saturday
preferredappointmenttimecode Edm.Int32

Select the preferred time of day for service appointments.

Display Name: Preferred Time

Default Options
Value Label
1 Morning
2 Afternoon
3 Evening
preferredcontactmethodcode Edm.Int32

Select the preferred method of contact.

Display Name: Preferred Method of Contact

Default Options
Value Label
1 Any
2 Email
3 Phone
4 Fax
5 Mail
primarysatoriid Edm.String

Primary Satori ID for Account

Display Name: Primary Satori ID

primarytwitterid Edm.String

Primary Twitter ID for Account

Display Name: Primary Twitter ID

processid Edm.Guid

Shows the ID of the process.

Display Name: Process

revenue Edm.Decimal

Type the annual revenue for the account, used as an indicator in financial performance analysis.

Display Name: Annual Revenue

revenue_base Edm.Decimal

Shows the annual revenue converted to the system's default base currency. The calculations use the exchange rate specified in the Currencies area.

Display Name: Annual Revenue (Base)

Read Only
sharesoutstanding Edm.Int32

Type the number of shares available to the public for the account. This number is used as an indicator in financial performance analysis.

Display Name: Shares Outstanding

shippingmethodcode Edm.Int32

Select a shipping method for deliveries sent to the account's address to designate the preferred carrier or other delivery option.

Display Name: Shipping Method

Default Options
Value Label
1 Default Value
sic Edm.String

Type the Standard Industrial Classification (SIC) code that indicates the account's primary industry of business, for use in marketing segmentation and demographic analysis.

Display Name: SIC Code

stageid Edm.Guid

Shows the ID of the stage.

Display Name: (Deprecated) Process Stage

statecode Edm.Int32

Shows whether the account is active or inactive. Inactive accounts are read-only and can't be edited unless they are reactivated.

Display Name: Status

Default Options
Value Label
0 Active
1 Inactive
statuscode Edm.Int32

Select the account's status.

Display Name: Status Reason

Default Options
Value Label
1 Active
2 Inactive
stockexchange Edm.String

Type the stock exchange at which the account is listed to track their stock and financial performance of the company.

Display Name: Stock Exchange

telephone1 Edm.String

Type the main phone number for this account.

Display Name: Main Phone

telephone2 Edm.String

Type a second phone number for this account.

Display Name: Other Phone

telephone3 Edm.String

Type a third phone number for this account.

Display Name: Telephone 3

territorycode Edm.Int32

Select a region or territory for the account for use in segmentation and analysis.

Display Name: Territory Code

Default Options
Value Label
1 Default Value
tickersymbol Edm.String

Type the stock exchange symbol for the account to track financial performance of the company. You can click the code entered in this field to access the latest trading information from MSN Money.

Display Name: Ticker Symbol

timespentbymeonemailandmeetings Edm.String

Total time spent for emails (read and write) and meetings by me in relation to account record.

Display Name: Time Spent by me

Read Only
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

traversedpath Edm.String

For internal use only.

Display Name: (Deprecated) Traversed Path

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version number of the account.

Display Name: Version Number

Read Only
websiteurl Edm.String

Type the account's website URL to get quick details about the company profile.

Display Name: Website

yominame Edm.String

Type the phonetic spelling of the company name, if specified in Japanese, to make sure the name is pronounced correctly in phone calls and other communications.

Display Name: Yomi Account Name

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties.

Name Single-valued navigation property Description
_createdby_value createdby

Shows who created the record.

_createdbyexternalparty_value createdby

Shows the external party who created the record.

_createdonbehalfby_value createdonbehalfby

Shows who created the record on behalf of another user.

_masterid_value masterid

Shows the master account that the account was merged with.

_modifiedby_value modifiedby

Shows who last updated the record.

_modifiedbyexternalparty_value createdby

Shows the external party who modified the record.

_modifiedonbehalfby_value modifiedonbehalfby

Shows who created the record on behalf of another user.

_ownerid_value ownerid

Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user.

_owningbusinessunit_value owningbusinessunit

Shows the business unit that the record owner belongs to.

_owningteam_value owningteam

Unique identifier of the team who owns the account.

_owninguser_value owninguser

Unique identifier of the user who owns the account.

_parentaccountid_value parentaccountid

Choose the parent account associated with this account to show parent and child businesses in reporting and analytics.

_preferredsystemuserid_value preferredsystemuserid

Choose the preferred service representative for reference when you schedule service activities for the account.

_primarycontactid_value primarycontactid

Choose the primary contact for the account to provide quick access to contact details.

_slaid_value sla_account_sla

Choose the service level agreement (SLA) that you want to apply to the Account record.

_slainvokedid_value slainvokedid_account_sla

Last SLA that was applied to this case. This field is for internal use only.

_transactioncurrencyid_value transactioncurrencyid

Choose the local currency for the record to make sure budgets are reported in the correct currency.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
createdby systemuser lk_accountbase_createdby
createdonbehalfby systemuser lk_accountbase_createdonbehalfby
masterid account account_master_account
modifiedby systemuser lk_accountbase_modifiedby
modifiedonbehalfby systemuser lk_accountbase_modifiedonbehalfby
ownerid principal owner_accounts
owningbusinessunit businessunit business_unit_accounts
owningteam team team_accounts
owninguser systemuser user_accounts
parentaccountid account account_parent_account
preferredsystemuserid systemuser system_user_accounts
primarycontactid contact account_primary_contact
sla_account_sla sla manualsla_account
slainvokedid_account_sla sla sla_account
stageid_processstage processstage processstage_account
transactioncurrencyid transactioncurrency transactioncurrency_account

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
account_actioncard actioncard regardingobjectid_account_actioncard
account_activity_parties activityparty partyid_account
Account_ActivityPointers activitypointer regardingobjectid_account
Account_Annotation annotation objectid_account
Account_Appointments appointment regardingobjectid_account_appointment
Account_AsyncOperations asyncoperation regardingobjectid_account
Account_BulkDeleteFailures bulkdeletefailure regardingobjectid_account
account_chats chat regardingobjectid_account_chat
account_connections1 connection record1id_account
account_connections2 connection record2id_account
Account_CustomerAddress customeraddress parentid_account
Account_DuplicateBaseRecord duplicaterecord baserecordid_account
Account_DuplicateMatchingRecord duplicaterecord duplicaterecordid_account
Account_Email_EmailSender email emailsender_account
Account_Email_SendersAccount email sendersaccount
Account_Emails email regardingobjectid_account_email
Account_Faxes fax regardingobjectid_account_fax
Account_Letters letter regardingobjectid_account_letter
Account_MailboxTrackingFolder mailboxtrackingfolder regardingobjectid_account
account_master_account account masterid
account_parent_account account parentaccountid
Account_Phonecalls phonecall regardingobjectid_account_phonecall
account_PostFollows postfollow regardingobjectid_account
account_PostRegardings postregarding regardingobjectid_account
account_principalobjectattributeaccess principalobjectattributeaccess objectid_account
Account_ProcessSessions processsession regardingobjectid_account
Account_RecurringAppointmentMasters recurringappointmentmaster regardingobjectid_account_recurringappointmentmaster
Account_SharepointDocumentLocation sharepointdocumentlocation regardingobjectid_account
Account_SocialActivities socialactivity regardingobjectid_account_socialactivity
Account_SyncErrors syncerror regardingobjectid_account_syncerror
Account_Tasks task regardingobjectid_account_task
contact_customer_accounts contact parentcustomerid_account
slakpiinstance_account slakpiinstance regarding_account
SocialActivity_PostAuthor_accounts socialactivity postauthor_account
SocialActivity_PostAuthorAccount_accounts socialactivity postauthoraccount_account
Socialprofile_customer_accounts socialprofile customerid_account

Operations

The following operations can be used with the account entity type.

Name Binding
GrantAccess Not Bound
Merge Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound
Rollup Not Bound

Solutions

The following solutions include the account entity type.

Name Description
Application Common For internal use only.
Application Common Patch For internal use only.
Second Patch for Application Common For internal use only.
System Solution Internal CRM System Solution

See also