businessunit EntityType

 

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

Description: Business, division, or department in the Microsoft Dynamics 365 database.

Entity Set path:[organization URI]/api/data/v8.2/businessunits

Base Type: crmbaseentity EntityType

Display Name: Business Unit

Primary Key: businessunitid

Primary Name Attribute: name

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to businessunit

Operations using the businessunit entity type.

Properties

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

Name

Type

Details

address1_addressid

Edm.Guid

Description: Unique identifier for address 1.

Display Name: Address 1: ID

address1_addresstypecode

Edm.Int32

Description: Type of address for address 1, such as billing, shipping, or primary address.

Default Options:

1 : Default Value

Display Name: Address 1: Address Type

address1_city

Edm.String

Description: City name for address 1.

Display Name: Bill To City

address1_country

Edm.String

Description: Country/region name for address 1.

Display Name: Bill To Country/Region

address1_county

Edm.String

Description: County name for address 1.

Display Name: Address 1: County

address1_fax

Edm.String

Description: Fax number for address 1.

Display Name: Address 1: Fax

address1_latitude

Edm.Double

Description: Latitude for address 1.

Display Name: Address 1: Latitude

address1_line1

Edm.String

Description: First line for entering address 1 information.

Display Name: Bill To Street 1

address1_line2

Edm.String

Description: Second line for entering address 1 information.

Display Name: Bill To Street 2

address1_line3

Edm.String

Description: Third line for entering address 1 information.

Display Name: Bill To Street 3

address1_longitude

Edm.Double

Description: Longitude for address 1.

Display Name: Address 1: Longitude

address1_name

Edm.String

Description: Name to enter for address 1.

Display Name: Address 1: Name

address1_postalcode

Edm.String

Description: ZIP Code or postal code for address 1.

Display Name: Bill To ZIP/Postal Code

address1_postofficebox

Edm.String

Description: Post office box number for address 1.

Display Name: Address 1: Post Office Box

address1_shippingmethodcode

Edm.Int32

Description: Method of shipment for address 1.

Default Options:

1 : Default Value

Display Name: Address 1: Shipping Method

address1_stateorprovince

Edm.String

Description: State or province for address 1.

Display Name: Bill To State/Province

address1_telephone1

Edm.String

Description: First telephone number associated with address 1.

Display Name: Main Phone

address1_telephone2

Edm.String

Description: Second telephone number associated with address 1.

Display Name: Other Phone

address1_telephone3

Edm.String

Description: Third telephone number associated with address 1.

Display Name: Address 1: Telephone 3

address1_upszone

Edm.String

Description: United Parcel Service (UPS) zone for address 1.

Display Name: Address 1: UPS Zone

address1_utcoffset

Edm.Int32

Description: UTC offset for address 1. This is the difference between local time and standard Coordinated Universal Time.

Display Name: Address 1: UTC Offset

address2_addressid

Edm.Guid

Description: Unique identifier for address 2.

Display Name: Address 2: ID

address2_addresstypecode

Edm.Int32

Description: Type of address for address 2, such as billing, shipping, or primary address.

Default Options:

1 : Default Value

Display Name: Address 2: Address Type

address2_city

Edm.String

Description: City name for address 2.

Display Name: Ship To City

address2_country

Edm.String

Description: Country/region name for address 2.

Display Name: Ship To Country/Region

address2_county

Edm.String

Description: County name for address 2.

Display Name: Address 2: County

address2_fax

Edm.String

Description: Fax number for address 2.

Display Name: Address 2: Fax

address2_latitude

Edm.Double

Description: Latitude for address 2.

Display Name: Address 2: Latitude

address2_line1

Edm.String

Description: First line for entering address 2 information.

Display Name: Ship To Street 1

address2_line2

Edm.String

Description: Second line for entering address 2 information.

Display Name: Ship To Street 2

address2_line3

Edm.String

Description: Third line for entering address 2 information.

Display Name: Ship To Street 3

address2_longitude

Edm.Double

Description: Longitude for address 2.

Display Name: Address 2: Longitude

address2_name

Edm.String

Description: Name to enter for address 2.

Display Name: Address 2: Name

address2_postalcode

Edm.String

Description: ZIP Code or postal code for address 2.

Display Name: Ship To ZIP/Postal Code

address2_postofficebox

Edm.String

Description: Post office box number for address 2.

Display Name: Address 2: Post Office Box

address2_shippingmethodcode

Edm.Int32

Description: Method of shipment for address 2.

Default Options:

1 : Default Value

Display Name: Address 2: Shipping Method

address2_stateorprovince

Edm.String

Description: State or province for address 2.

Display Name: Ship To State/Province

address2_telephone1

Edm.String

Description: First telephone number associated with address 2.

Display Name: Address 2: Telephone 1

address2_telephone2

Edm.String

Description: Second telephone number associated with address 2.

Display Name: Address 2: Telephone 2

address2_telephone3

Edm.String

Description: Third telephone number associated with address 2.

Display Name: Address 2: Telephone 3

address2_upszone

Edm.String

Description: United Parcel Service (UPS) zone for address 2.

Display Name: Address 2: UPS Zone

address2_utcoffset

Edm.Int32

Description: UTC offset for address 2. This is the difference between local time and standard Coordinated Universal Time.

Display Name: Address 2: UTC Offset

businessunitid

Edm.Guid

Description: Unique identifier of the business unit.

Display Name: Business Unit

costcenter

Edm.String

Description: Name of the business unit cost center.

Display Name: Cost Center

createdon

Edm.DateTimeOffset

Description: Date and time when the business unit was created.

Display Name: Created On

Read-only property

creditlimit

Edm.Double

Description: Credit limit for the business unit.

Display Name: Credit Limit

description

Edm.String

Description: Description of the business unit.

Display Name: Description

disabledreason

Edm.String

Description: Reason for disabling the business unit.

Display Name: Disable Reason

Read-only property

divisionname

Edm.String

Description: Name of the division to which the business unit belongs.

Display Name: Division

emailaddress

Edm.String

Description: Email address for the business unit.

Display Name: Email

exchangerate

Edm.Decimal

Description: Exchange rate for the currency associated with the businessunit with respect to the base currency.

Display Name: Exchange Rate

Read-only property

fileasname

Edm.String

Description: Alternative name under which the business unit can be filed.

Display Name: File as Name

ftpsiteurl

Edm.String

Description: FTP site URL for the business unit.

Display Name: FTP Site

importsequencenumber

Edm.Int32

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

Display Name: Import Sequence Number

inheritancemask

Edm.Int32

Description: Inheritance mask for the business unit.

Display Name: Inheritance Mask

isdisabled

Edm.Boolean

Description: Information about whether the business unit is enabled or disabled.

Default Options:

1 : Yes
0 : No

Display Name: Is Disabled

Read-only property

modifiedon

Edm.DateTimeOffset

Description: Date and time when the business unit was last modified.

Display Name: Modified On

Read-only property

name

Edm.String

Description: Name of the business unit.

Display Name: Name

overriddencreatedon

Edm.DateTimeOffset

Description: Date and time that the record was migrated.

Display Name: Record Created On

picture

Edm.String

Description: Picture or diagram of the business unit.

Display Name: Picture

stockexchange

Edm.String

Description: Stock exchange on which the business is listed.

Display Name: Stock Exchange

tickersymbol

Edm.String

Description: Stock exchange ticker symbol for the business unit.

Display Name: Ticker Symbol

utcoffset

Edm.Int32

Description: UTC offset for the business unit. This is the difference between local time and standard Coordinated Universal Time.

Display Name: UTC Offset

versionnumber

Edm.Int64

Description: Version number of the business unit.

Display Name: Version number

Read-only property

websiteurl

Edm.String

Description: Website URL for the business unit.

Display Name: Website

workflowsuspended

Edm.Boolean

Description: Information about whether workflow or sales process rules have been suspended.

Default Options:

1 : Yes
0 : No

Display Name: Workflow Suspended

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

_calendarid_value

calendarid

Fiscal calendar associated with the business unit.

_createdby_value

createdby

Unique identifier of the user who created the business unit.

_createdonbehalfby_value

createdonbehalfby

Unique identifier of the delegate user who created the businessunit.

_modifiedby_value

modifiedby

Unique identifier of the user who last modified the business unit.

_modifiedonbehalfby_value

modifiedonbehalfby

Unique identifier of the delegate user who last modified the businessunit.

_organizationid_value

organizationid

Unique identifier of the organization associated with the business unit.

_parentbusinessunitid_value

parentbusinessunitid

Unique identifier for the parent business unit.

_transactioncurrencyid_value

transactioncurrencyid

Unique identifier of the currency associated with the businessunit.

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

calendarid

calendar EntityType

BusinessUnit_Calendar

createdby

systemuser EntityType

lk_businessunitbase_createdby

createdonbehalfby

systemuser EntityType

lk_businessunit_createdonbehalfby

modifiedby

systemuser EntityType

lk_businessunitbase_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_businessunit_modifiedonbehalfby

organizationid

organization EntityType

organization_business_units

parentbusinessunitid

businessunit EntityType

business_unit_parent_business_unit

transactioncurrencyid

transactioncurrency EntityType

TransactionCurrency_BusinessUnit

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

BulkDeleteOperation_BusinessUnit

bulkdeleteoperation EntityType

owningbusinessunit

business_unit_accounts

account EntityType

owningbusinessunit

business_unit_actioncards

actioncard EntityType

owningbusinessunit

business_unit_activitypointer

activitypointer EntityType

owningbusinessunit

business_unit_annotations

annotation EntityType

owningbusinessunit

business_unit_appointment_activities

appointment EntityType

owningbusinessunit_appointment

business_unit_asyncoperation

asyncoperation EntityType

owningbusinessunit

business_unit_bookableresource

bookableresource EntityType

owningbusinessunit

business_unit_bookableresourcebooking

bookableresourcebooking EntityType

owningbusinessunit

business_unit_bookableresourcebookingheader

bookableresourcebookingheader EntityType

owningbusinessunit

business_unit_bookableresourcecategory

bookableresourcecategory EntityType

owningbusinessunit

business_unit_bookableresourcecategoryassn

bookableresourcecategoryassn EntityType

owningbusinessunit

business_unit_bookableresourcecharacteristic

bookableresourcecharacteristic EntityType

owningbusinessunit

business_unit_bookableresourcegroup

bookableresourcegroup EntityType

owningbusinessunit

business_unit_bookingstatus

bookingstatus EntityType

owningbusinessunit

business_unit_BulkOperation_activities

bulkoperation EntityType

owningbusinessunit_bulkoperation

business_unit_calendars

calendar EntityType

businessunitid

business_unit_campaignactivity_activities

campaignactivity EntityType

owningbusinessunit_campaignactivity

business_unit_campaignresponse_activities

campaignresponse EntityType

owningbusinessunit_campaignresponse

business_unit_category

category EntityType

owningbusinessunit

business_unit_characteristic

characteristic EntityType

owningbusinessunit

business_unit_connections

connection EntityType

owningbusinessunit

business_unit_constraint_based_groups

constraintbasedgroup EntityType

businessunitid_businessunit

business_unit_contacts

contact EntityType

owningbusinessunit

business_unit_dynamicproperyinstance

dynamicpropertyinstance EntityType

owningbusinessunit

business_unit_email_activities

email EntityType

owningbusinessunit_email

business_unit_emailserverprofile

emailserverprofile EntityType

owningbusinessunit

business_unit_entitlement

entitlement EntityType

owningbusinessunit

business_unit_equipment

equipment EntityType

businessunitid_businessunit

business_unit_exchangesyncidmapping

exchangesyncidmapping EntityType

owningbusinessunit

business_unit_fax_activities

fax EntityType

owningbusinessunit_fax

business_unit_feedback

feedback EntityType

owningbusinessunit

business_unit_goal

goal EntityType

owningbusinessunit

business_unit_goalrollupquery

goalrollupquery EntityType

owningbusinessunit

business_unit_incident_resolution_activities

incidentresolution EntityType

owningbusinessunit_incidentresolution

business_unit_incidents

incident EntityType

owningbusinessunit

business_unit_invoices

invoice EntityType

owningbusinessunit

business_unit_knowledgearticle

knowledgearticle EntityType

owningbusinessunit

business_unit_leads

lead EntityType

owningbusinessunit

business_unit_letter_activities

letter EntityType

owningbusinessunit_letter

business_unit_list

list EntityType

owningbusinessunit

business_unit_mailbox

mailbox EntityType

owningbusinessunit

business_unit_mailmergetemplates

mailmergetemplate EntityType

owningbusinessunit

business_unit_new_interactionforemail

interactionforemail EntityType

owningbusinessunit

business_unit_opportunities

opportunity EntityType

owningbusinessunit

business_unit_opportunity_close_activities

opportunityclose EntityType

owningbusinessunit_opportunityclose

business_unit_order_close_activities

orderclose EntityType

owningbusinessunit_orderclose

business_unit_orders

salesorder EntityType

owningbusinessunit

business_unit_parent_business_unit

businessunit EntityType

parentbusinessunitid

business_unit_personaldocumenttemplates

personaldocumenttemplate EntityType

owningbusinessunit

business_unit_phone_call_activities

phonecall EntityType

owningbusinessunit_phonecall

business_unit_postfollows

postfollow EntityType

owningbusinessunit

business_unit_PostRegarding

postregarding EntityType

regardingobjectowningbusinessunit

business_unit_queues

queue EntityType

businessunitid

business_unit_queues2

queue EntityType

owningbusinessunit

business_unit_quote_close_activities

quoteclose EntityType

owningbusinessunit_quoteclose

business_unit_quotes

quote EntityType

owningbusinessunit

business_unit_ratingmodel

ratingmodel EntityType

owningbusinessunit

business_unit_ratingvalue

ratingvalue EntityType

owningbusinessunit

business_unit_recurringappointmentmaster_activities

recurringappointmentmaster EntityType

owningbusinessunit_recurringappointmentmaster

business_unit_reports

report EntityType

owningbusinessunit

business_unit_resource_groups

resourcegroup EntityType

businessunitid

business_unit_resource_specs

resourcespec EntityType

businessunitid

business_unit_resources

resource EntityType

businessunitid

business_unit_roles

role EntityType

businessunitid

business_unit_service_appointments

serviceappointment EntityType

owningbusinessunit_serviceappointment

business_unit_service_contracts

contract EntityType

owningbusinessunit

business_unit_sharepointdocumentlocation

sharepointdocumentlocation EntityType

owningbusinessunit

business_unit_sharepointsites

sharepointsite EntityType

owningbusinessunit

business_unit_slabase

sla EntityType

owningbusinessunit

business_unit_slakpiinstance

slakpiinstance EntityType

owningbusinessunit

business_unit_socialactivity

socialactivity EntityType

owningbusinessunit_socialactivity

business_unit_socialprofiles

socialprofile EntityType

owningbusinessunit

business_unit_system_users

systemuser EntityType

businessunitid

business_unit_task_activities

task EntityType

owningbusinessunit_task

business_unit_teams

team EntityType

businessunitid

business_unit_templates

template EntityType

owningbusinessunit

business_unit_user_settings

usersettings EntityType

businessunitid_businessunit

business_unit_userform

userform EntityType

owningbusinessunit

business_unit_userquery

userquery EntityType

owningbusinessunit

business_unit_userqueryvisualizations

userqueryvisualization EntityType

owningbusinessunit

business_unit_workflow

workflow EntityType

owningbusinessunit

business_unit_workflowlogs

workflowlog EntityType

owningbusinessunit

BusinessUnit_AsyncOperations

asyncoperation EntityType

regardingobjectid_businessunit

BusinessUnit_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_businessunit

BusinessUnit_Campaigns

campaign EntityType

owningbusinessunit

BusinessUnit_DuplicateRules

duplicaterule EntityType

owningbusinessunit

BusinessUnit_ImportData

importdata EntityType

owningbusinessunit

BusinessUnit_ImportFiles

importfile EntityType

owningbusinessunit

BusinessUnit_ImportLogs

importlog EntityType

owningbusinessunit

BusinessUnit_ImportMaps

importmap EntityType

owningbusinessunit

BusinessUnit_Imports

import EntityType

owningbusinessunit

BusinessUnit_SyncError

syncerror EntityType

owningbusinessunit

BusinessUnit_SyncErrors

syncerror EntityType

regardingobjectid_businessunit_syncerror

Operations bound to businessunit

The following operations are bound to the businessunit entity type.

Name

Bound to

RetrieveBusinessHierarchyBusinessUnit Function

Entity

Operations using the businessunit entity type.

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

Name

How used

Description

SetBusinessSystemUser Action

BusinessUnit Parameter

Moves a system user (user) to a different business unit.

RetrieveBusinessHierarchyBusinessUnit Function

entity Parameter

Retrieves all business units from the business unit hierarchy.

RetrieveBusinessHierarchyBusinessUnit Function

ReturnType

Retrieves all business units from the business unit hierarchy.

See Also

Use the Microsoft Dynamics 365 Web API
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright