Microsoft Dynamics
Marketing Help & Training
Search

OData Feeds Overview

OData feeds enable you to use Power BI, Microsoft Excel, and other external systems to consume live data directly from Dynamics Marketing. Use these capabilities to create custom reports, interactive analytics, and more. For more information, search the Dynamics Marketing online help for "OData".

Company  (top)

Companies are used for marketing, vendors, clients and the site company.

This feed provides information on all the contacts in a company, as well as the relevant expenses that have occurred for this company. A company represents the information that describes a business entity that can be one of the following types: marketing, vendor, client, or site company. Aside from the address, this feed provides expansions on relevant programs, campaigns, and leads. A marketing company always belongs to a client or site company. For client and site companies, the feed lists the default lead creation granularity and the default scoring model.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Guid

Name

The name of the company.

false

160

false

String

true

Address

The street address of the company.

false

250

String

true

City

The city where the company exists.

false

50

String

true

State

The state a company resides in.

false

250

String

true

PostalCode

The postal code of the company.

false

70

String

true

Country

The country or region of this company.

false

250

String

true

Type

The type of the company, which can be marketing, vendor, client or site company.

The same company can have multiple types, but the only combination of multiple types that is allowed for companies at the same time is client and vendor.

false

750

String

true

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

LeadScoringModelId

This refers to the default scoring model that is used to score leads.

This is relevant for the site or client company only.

false

Int32

LeadScoringModelName

The name of the default scoring model that is used to score leads.

This is relevant for the site or client company only.

false

250

String

true

LeadCreationScope

This defines a part of the lead creation granularity.

This defines whether leads are created per campaign, program, or per site company. This is relevant for the site or client company only.

false

250

String

true

LeadCreationStrategy

This defines a part of the lead creation granularity.

This defines whether leads are created per marketing contact or marketing company. This is relevant for the site or client company only.

false

250

String

true

OriginOfChanges

The origin of changes describes sources that have most recently applied changes to an object.

false

Max

String

true

YomiName

In Japanese this is the phonetic equivalent of a Kanji name in the Name field.

Enter the phonetic equivalent for the Japanese name into a Yomi field. In Japanese, there is commonly a Furigana equivalent for the Kanji name that is used for sorting and searching, which may be used in a Yomi field.

false

160

String

true

CRMId

The ID an object has in Microsoft Dynamics CRM.

The Microsoft Dynamics Marketing Connector for Microsoft Dynamics CRM synchronizes data between the two systems. For objects that have a corresponding object in Dynamics Marketing, this field contains the unique ID this object has in Dynamics CRM.

Guid

ChildContactCount

The number of contacts that have this company as a parent.

Typically, the contacts counted in this number work for this company.

false

Int32

OwnedLeadCount

The number of leads that have been created for prospects as a result of marketing activities that are owned by this company.

This number is a measure for client companies or site companies. It counts the number of leads that have a company as a Belongs To company.

false

Int32

ChildLeadCount

The number of leads that have been created for the company as a prospect.

The leads counted in this number reflect expressions of interest that have been captured for interactions of child contacts to marketing activities.

false

Int32

OwnedMarketingContactCount

The number of marketing contacts that have this company as their Belongs To company.

This number is a measure for client companies or a site company. It counts the number of marketing contacts that have this company as a Belongs To company.

false

Int32

OwnedMarketingCompanyCount

The number of marketing companies that have this company as their Belongs To company.

This number is a measure for client companies or a site company. It counts the number of marketing companies that have this company as a Belongs To company.

false

Int32

DoubleOptIn

For the Belongs To companies, this indicates whether double opt-in has been enabled.

If double opt-in has been enabled for a site company or a client company, this field will indicate this. This attribute isn't relevant for marketing companies.

false

Boolean

ExternalId

This shows the external ID of the object that is typically used through the SDK.

The external ID of an object is a unique identifier (GUID) by which an object can be referenced in SDK calls.

false

Guid

Status

Shows the status of the company.

Of special note is the "Deleted" status, which marks the company as deleted (so it will no longer appear in list views and other parts of Dynamics Marketing), but still keeps it in your database in case you need it later.

false

250

String

true

Relations

Name

Summary

Description

Contacts

This is a table of contacts in a company.

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

Leads

These are leads that have been created for this company.

This is typically used for marketing companies.

Expenses

This is a table of related expenses.

Campaigns

This is a table of related campaigns.

Programs

This is a list of programs that this company runs.

This is relevant for the site or client company only.

MarketingContexts

These are relevant marketing contexts that this company caters in.

This is relevant for the site or client company only.

LeadScoringModel

The default scoring model used to score leads.

This is relevant for the site or client company only.

Divisions

This is a list of all the divisions in this company.

Departments

This is a list of all the departments in this company.

JobRequests

This is a list of all the job requests made in this company.

Estimates

The table of expenses that belong to this company.

 
Contact  (top)

A contact is a person in marketing, or with a vendor or client, or a site company.

In Microsoft Dynamics Marketing, a contact represents the information that describes an individual who is one of the following types: a marketing contact, vendor contact, or client contact. The contact's address, email, phone number, time zone, language, and currency are recorded in Microsoft Dynamics Marketing, as well as the parent company that the contact represents. A marketing contact always belongs to a client or site company. A set of key indicators for each contact are available in an expandable KPI (Key Performance Indicator) object.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Guid

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

BelongsToCompanyName

The name of the client or site company that owns this object.

The BelongsTo company can only be set when an object is created and cannot be changed later.

false

160

String

true

ParentCompanyId

This refers to the company that the contact works for.

Guid

ParentCompanyName

This is the name of the company that the contact works for.

false

160

String

true

IsActive

This indicates if this contact is active.

It is set to True if the contact is active; otherwise, it is set to False.

false

Boolean

Type

The type of contact, which can be marketing, vendor, client, or staff.

The same contact can have multiple types, but the only combinations of multiple types that are allowed for contacts at the same time are: client and vendor, client and staff, or vendor and staff.

false

750

String

true

Salutation

The salutation used with the contact.

false

250

String

true

Title

The honorific title for the contact.

false

100

String

true

FirstName

The first name of the contact.

false

70

String

true

LastName

The last name of the contact.

false

70

String

true

Address

The street address of the contact.

false

250

String

true

City

The city of the contact's address.

false

50

String

true

State

The state where the contact resides.

false

250

String

true

PostalCode

The postal code of the contact's address.

false

70

String

true

Country

This is the country or region of the contact's address.

false

250

String

true

Email

The email address of the contact.

false

320

String

true

Phone

The phone number of this contact.

false

50

String

true

Territory

The sales territory that this contact has been assigned to.

false

250

String

true

UpdateDate

The date and time this entity was last updated.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

7

DateTime

CreateDate

This is the date and time the contact was created.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

TimeZone

The time zone associated with this contact.

Date and time values are stored in the UTC, but it is important to know the time zone certain marketing activities take place in.

false

250

String

true

Currency

The currency used in monetary transactions with this contact.

false

250

String

true

Insignificant

This indicates a contact without a sales-ready lead.

This is mainly used for the connection with Microsoft Dynamics CRM.

false

Boolean

Role

The role the contact has within the company.

Available roles are defined by the category "Team Role."

false

250

String

true

Language

The language associated with this contact that can be used to target marketing activities.

false

250

String

true

OriginOfChanges

The origin of changes describes the sources that have most recently applied changes to an object.

false

Max

String

true

DoNotEmail

This refers to the customer's choice not to receive marketing email.

false

Boolean

DoNotCall

This refers to the customer's choice not to receive marketing phone calls.

false

Boolean

DoNotMail

This refers to the customer's choice not to receive marketing mail.

false

Boolean

ContactPreference

This describes the preferred text format for email communication chosen by a contact.

This can be HTML or plain text. The default is HTML.

false

250

String

true

MessageFormatHTML

This refers to the customer's choice to receive HTML formatted email.

false

Int16

MessageFormatText

This refers to the customer's choice to receive text-formatted email.

false

Int32

YomiFirstName

In Japanese this is the phonetic equivalent for a Kanji name in the First Name field.

In Japanese, there is commonly a Furigana equivalent for the Kanji name that is used for sorting and searching which may be used in a Yomi field. Enter the phonetic equivalent for the Japanese name into a Yomi field.

false

70

String

true

YomiLastName

In Japanese this is the phonetic equivalent for a Kanji name in the Last Name field.

In Japanese, there is commonly a Furigana equivalent for the Kanji name that is used for sorting and searching which may be used in a Yomi field. Enter the phonetic equivalent for the Japanese name into a Yomi field.

false

70

String

true

YomiFullName

In Japanese this is the phonetic equivalent for a Kanji name in the Full Name field.

In Japanese, there is commonly a Furigana equivalent for the Kanji name that is used for sorting and searching which may be used in a Yomi field. Enter the phonetic equivalent for the Japanese name into a Yomi field.

false

200

String

true

Memo

Memo text added to the record. This text typically provides extra information and/or comments.

false

Max

String

true

CRMId

The ID for the contact in Microsoft Dynamics CRM.

The Microsoft Dynamics Marketing Connector for Microsoft Dynamics CRM synchronizes data between the two systems. For objects that have a corresponding object in Dynamics CRM, this field contains the unique ID for the contact.

Guid

ExternalId

This shows the external ID of the object that is typically used through the SDK.

The external ID of an object is a unique identifier (GUID) by which an object can be referenced in SDK calls.

false

Guid

MobilePhone

The mobile phone number of this contact.

false

50

String

true

DoNotSms

This refers to the customer's choice not to receive marketing SMS messages.

NOTE: the SMS feature was discontinued in Microsoft Dynamics Marketing 2016 Update 0.9. This field is no longer used by the application, but is still available for recording contacts' preferences.

false

Boolean

UrlId

A unique ID that you can use to construct a URL that links directly to the specified contact

The user that clicks the link must be signed into Dynamics Marketing to see the page. Create a URL with the following format (where <Contact.UrlId> is the value of this OData field and <YourOrg> is the organization name you normally use in the URL when opening Dynamics Marketing): https://<YourOrg>.marketing.dynamics.com /Contacts/MaintainContact.aspx?OID=<Contact.UrlId> &RETURNPAGE=/Contacts/MaintainContact.aspx

false

Int32

Relations

Name

Summary

Description

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

ParentCompany

Reference to the company that the contact works for.

MarketingLists

Table of static marketing lists that this contact is part of.

VisitedWebSites

Table of Web Sites that have been visited by the contact.

The list of Microsoft Dynamics Marketing websites that have tracked visits on webpages by a contact. Webpages must be equipped with the tracking script from the respective Web Site object.

Visits

The table of web visits for this contact.

Attendances

Table of records of attendance to an event or session.

EventRegistrations

Tables of registrations to an event or session.

LeadInteractions

Table of Lead Interactions that originate from this contact.

JobRequests

Table of relevant job requests for this contact.

CustomFields

A table of custom fields and values for this contact, grouped by data type

Results

Table of marketing results that for this contact

 
Lead  (top)

A lead represents the expressed interest of a marketing contact or a marketing company in response to marketing activities.

Leads come about when a prospect or contact expresses interest in a product or service that you've publicized through marketing activities. The prospect registers information on a landing page, and from that information, you can create the lead. Depending on your lead creation strategy, leads are scored (and graded) so that you can ascertain their sales potential. For example, a certain score may indicate that a lead is "sales-ready" and a salesperson should be assigned to that lead, while another score may indicate that the lead isn't interested enough to have a salesperson call.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Guid

Name

The name for this lead.

false

300

false

String

true

Status

The status contains a value from the status category for an entity.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

250

String

true

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

false

Guid

LeadDate

The date and time when this lead was created.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

LeadDueDate

The date and time when this lead is due for a follow up.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

ContactId

This refers to the prospect contact for whom this lead has been recorded.

This is relevant for the lead creation strategy "'Per Contact".

Guid

CompanyId

This refers to the prospect company for whom this lead has been recorded.

Guid

CampaignId

This refers to the campaign that this marketing entity is used in.

false

Int32

ProgramId

This refers to the program that this marketing entity is used in.

false

Int32

LeadScoringModelId

This refers to the effective lead scoring model for this lead.

false

Int32

Territory

The territory this lead has been assigned to.

The Territory field can have values that have been defined in the respective category.

false

250

String

true

SalesRating

A value that reflects the rating for a lead given by a Sales team.

The Sales Rating field can have values that have been defined in the respective category. The Sales Rating can be used as additional input for scoring and allows input from the Sales Force on an individual lead influence score. The Sales Rating is typically set by the Sales Rep in Microsoft Dynamics CRM and synced via the connector to Microsoft Dynamics Marketing.

false

250

String

true

Score

This reflects the numeric score value after lead scoring.

With the help of a scoring model, a lead is scored and receives the values "Score" and "ScoringGrade".

false

Double

SalesReady

A value that reflects whether a lead is ready to be sent to the sales team in the CRM.

With the help of a scoring model, a lead is scored and receives the values "Score" and "ScoringGrade". If a scoring grade is marked as sales ready, this property will be set and the lead be synced to Microsoft Dynamics CRM through the Microsoft Dynamics CRM Connector.

false

Boolean

TotalInteractionsCount

The total number of interactions by prospect contacts that have been associated with this lead.

false

Int32

Priority

The priority assigned to processing this lead.

The Priority field can have values that have been defined in the respective category.

false

250

String

true

OriginOfChanges

The origin of changes describes the sources that have most recently applied changes to an object.

false

Max

String

true

BelongsToCompanyName

The name of the client or site company that owns this object.

The BelongsTo company can only be set when an object is created and cannot be changed later.

false

160

false

String

true

ContactName

The name of the prospect contact for whom this lead has been recorded.

This is relevant for the lead creation strategy "'Per Contact".

false

200

String

true

CompanyName

The name of the prospect company for whom this lead has been recorded.

false

160

String

true

CampaignName

The name of the campaign that this marketing entity is used in.

false

128

String

true

ProgramName

The name of the program that this marketing entity is used in.

false

70

String

true

CRMId

This refers to the ID of a lead in Microsoft Dynamics CRM.

The Microsoft Dynamics Marketing Connector for Microsoft Dynamics CRM synchronizes data between the two systems. For objects that have a corresponding object in Dynamics CRM, this field contains the unique ID this object has in Microsoft Dynamics Marketing.

Guid

ScoringGradeId

The unique identifier of the scoring grade assigned by the relevant scoring model.

false

101

String

true

Type

The type of lead.

The possible type value are maintained by a category.

false

250

String

true

PriorityCategoryId

This refers to the priority category value.

Int32

TerritoryCategoryId

This refers to the selected territory category value.

The available values are defined by a category definition for this entity and this field.

Int32

SalesRatingCategoryId

This refers to the category value that has been selected for the leads sales rating.

Int32

StatusCategoryId

This refers to the selected status category value.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

Int32

ExternalId

This shows the external ID of the object that is typically used through the SDK.

The external ID of an object is a unique identifier (GUID) by which an object can be referenced in SDK calls.

false

Guid

AssignedToId

The unique identifier of the contact that the lead has been assigned to.

This is typically the contact of a user in Dynamics Marketing.

Guid

UrlId

A unique ID that you can use to construct a URL that links directly to the specified lead

The user that clicks the link must be signed into Dynamics Marketing to see the page. Create a URL with the following format (where <Lead.UrlId> is the value of this OData field and <YourOrg> is the organization name you normally use in the URL when opening Dynamics Marketing): https://<YourOrg>.marketing.dynamics.com /LeadManagement/MaintainLeadManagement.aspx?OID=<Lead.UrlId> &RETURNPAGE=/LeadManagement/MaintainLeadManagement.aspx.

false

Int32

Relations

Name

Summary

Description

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

Contact

This refers to the prospect contact behind the lead.

This refers to the contact behind the lead, if leads are created per contact. If leads are created per company this field is empty.

Company

This refers to the prospect company behind the lead.

This refers to the company behind the lead, if leads are created per company or the parent company of the contact, if leads are created per contact and the contact has a parent company.

Campaign

This refers to the campaign that this marketing entity is used in.

Program

This refers to the program that this marketing entity is used in.

LeadScoringModel

An effective lead scoring model for this lead.

With the help of a scoring model, a lead is scored and receives the values "Score" and "ScoringGrade". If a scoring grade is marked as sales ready, this property will be set and the lead will be synced to Microsoft Dynamics CRM through the Microsoft Dynamics CRM Connector.

LeadScoringEvents

A table of lead scoring events that are used to calculate the score for this lead.

When a scoring model for a Lead calculates the Score and ScoringGrade values, it evaluates various rules based on conditions and events. The list of scoring events represents a timeline of calculation steps that can be used to draw a visual view of the scoring calculation.

LeadInteractions

A table of lead interactions that refer to this lead.

The set of lead interactions which are assigned to a lead depends on the effective lead creation granularity in the marketing context of the lead. As a result of this granularity, only interactions in the scope of a single campaign and a single marketing contact may be assigned to a lead. With a different strategy, interactions of multiple contacts that work for the same marketing company and for multiple campaigns may be aggregated under one lead.

Offers

A table of offers that have been made into a lead.

Opportunities

A list of opportunities that has been created for this lead.

LeadScoringModelGrade

The scoring grade that has been assigned to this lead as a result of the relevant scoring model.

AssignedTo

The contact that the lead has been assigned to.

This is typically the contact of a user in Dynamics Marketing.

 
LeadScoringEvent  (top)

The list of scoring events represents a timeline of calculation steps that can be used to draw a visual view of the scoring calculation.

Lead scoring events are calculated for a lead when running the score calculation. The calculation uses rules of the relevant scoring model for the lead such that for each lead and rule that yields a score result, one scoring event is created. Some rules create only one event, like rules that score on demographic attributes. Other rules may create one score event for each prospect interaction. And some rules may create multiple recurring scoring events over a time period, for example when devaluating the score event for a previous interaction.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

62

false

String

true

RuleType

The type of rule from which this scoring event stems.

false

100

String

true

RuleField

The field in the rule from which this scoring event stems.

false

70

String

true

ScoreDelta

The value by which the score is increased or decreased due to this scoring event.

false

Double

LeadId

This refers to the lead with which this scoring event is associated and to whose score it contributes.

Guid

Date

The date when this item was created.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

Relations

Name

Summary

Description

Lead

This refers to the lead with which this scoring event is associated and to whose score it contributes.

 
Expense  (top)

An expense record is a financial entity that captures the expenses for a number of items.

An expense is assigned to an Accounts Payable (AP) account. It contains the sum of different costs and taxes for all items. It carries the legal terms and currency (which is the same for all items). The expense is typically prepared by one contact or company for another contact or company. The expense is often made for a service delivered by a vendor and is connected to an invoice from the vendor.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

ExpenseNumber

A generated number that has been assigned to the expense.

The expense number is only unique within expenses. This number is different from the ID of the entity.

false

70

false

String

true

Status

The status contains a value from the status category for an entity.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

250

String

true

Description

Descriptive text for this entity.

false

Max

String

true

Memo

Memo text added to the record. This text typically provides extra information and/or comments.

false

Max

String

true

PaymentType

The type of payment being used for the expense.

false

250

String

true

ExpenseTerms

Legal terms that apply for the expense.

false

250

String

true

CreationDate

The date when the expense was created.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

DueDate

The date the expense is due.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

VendorContactId

This refers to the vendor contact associated with the expense.

Guid

VendorContactName

The name of the vendor contact associated with the expense.

false

200

String

true

VendorCompanyId

This refers to the vendor company associated with the expense.

Guid

VendorCompanyName

The name of the vendor company associated with the expense.

false

160

String

true

PreparedByContactId

This refers to the contact that prepared the expense.

Guid

PreparedByContactName

The name of the contact who prepared the expense.

false

200

String

true

PreparedByCompanyId

This refers to the company that prepared the expense.

Guid

PreparedByCompanyName

Name of the company that prepared the expense.

false

160

String

true

PreparedForContactId

This refers to the contact that the expense was prepared for.

Guid

PreparedForContactName

The name of the contact that the expense was prepared for.

false

200

String

true

PreparedForCompanyId

This refers to the company that the expense was prepared for.

Guid

PreparedForCompanyName

The name of the company that the expense was prepared for.

false

160

String

true

VendorInvoiceNumber

The invoice number sent by the vendor for this expense.

false

70

String

true

TrackingNumber

The tracking number associated with the expense.

false

70

String

true

TotalCost

The total cost of the expense.

false

Double

TaxRate

The tax rate that applies to the expense.

false

Double

TotalTax

The total sum of taxes for the expense.

false

Double

ShippingCost

The cost of shipping for the expense.

false

Double

TotalQuantity

The total quantity of items covered by the expense.

false

Double

CurrencyName

The name of the currency that is used for all financial numbers in this object.

The currency is a category in the system.

false

250

String

true

AccountId

This refers to the Accounts Payable account that the expense is assigned to.

false

Int32

AccountName

The name of the Accounts Payable account that the expense is assigned to.

false

4000

String

true

PurchaseOrderId

Unique identifier of a related purchase order.

Int32

DepartmentId

The unique ID for the department associated with each record.

Int32

DivisionId

The unique ID for the division associated with each record.

Int32

Relations

Name

Summary

Description

VendorContact

This refers to the vendor contact associated with the expense.

VendorCompany

This refers to the vendor company associated with the expense.

ExpenseItems

A table of expense items that are part of the expense.

PurchaseOrder

This refers to the purchase order that's expensed at least partly by items in this expense.

Department

Full details for the department associated with each record.

Division

Full details for the division associated with each record.

BusinessSegmentExpenses

A table of business segments that apply to the expense.

 
ExpenseItem  (top)

A table of expense items that are part of the expense.

An expense item record is a financial entity that captures the expenses for an item. It is assigned to an (expense) account and contains the different costs and taxes for the item. It also carries additional details like date or currency used. The budget category and marketing context the item is related to are also available in this record.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

ExpenseId

This refers to the expense that this item belongs to.

false

Int32

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

false

Guid

BelongsToCompanyName

The name of the client or site company that owns this object.

The BelongsTo company can only be set when an object is created and cannot be changed later.

false

160

false

String

true

Date

The date when this item was created.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

Description

Descriptive text for this entity.

false

Max

String

true

ProgramId

This refers to the program that this marketing entity is used in.

false

Int32

ProgramName

The name of the program that this marketing entity is used in.

false

70

String

true

CampaignId

This refers to the campaign that this marketing entity is used in.

false

Int32

CampaignName

The name of the campaign that this marketing entity is used in.

false

128

String

true

ComponentId

The ID of the component record that this expense item applies to.

false

Int32

ComponentName

The name of the component that this expense item applies to.

false

70

String

true

AccountId

This refers to the expense account that the expense item is assigned to.

false

Int32

AccountName

The name of the expense account that the expense item is assigned to.

false

4000

String

true

BudgetCategory

A budget category value for this expense.

The available values are defined by a category definition for this entity and this field.

false

250

String

true

CurrencyName

The name of the currency that is used for all financial numbers in this object.

The currency is a category in the system.

false

250

String

true

Quantity

The quantity of units in this item.

false

Double

ShippingCost

The shipping cost for this item.

false

Double

Credit

A payment credit granted for the expense item.

false

Double

UnitCost

The cost per unit in this item.

false

Double

TotalCost

The total cost of this expense item.

false

Double

IsTaxable

A value indicating whether transactions for this item or service are taxable.

false

Boolean

EventId

The unique ID of an event associated with this entity.

false

Int32

JobId

This refers to a related job for this entity.

false

Int32

TaskId

This refers to a related task for this entity.

false

Int32

ProjectRequestId

This refers to a related project request.

false

Int32

ItemServiceId

This refers to an item or service that these expense items are made for.

false

Int32

BudgetCategoryId

This refers to the budget category value for this expense.

The available values are defined by a category definition for this entity and this field.

Int32

CurrencyCategoryId

This refers to the currency that is used by this financial item.

The available values are defined by a category definition for this entity and this field.

false

Int32

RelatedPurchaseOrderItemId

Refers to purchase order item that had occurred this expense item.

When a user creates an expense for purchase order items, then the respective expense items will be related to the order item by this relation. This relation mechanic does neither guarantee to represent a complete picture and nor to be correct by accounting standards.

Int32

Expensed

For expense items associated with a purchase-order item, this value represents the total value already expensed for that item.

false

Double

Balance

For expense items associated with a purchase-order item, this value represents the total value not yet expensed for that item.

false

Double

DepartmentId

The unique ID for the department associated with each record.

Int32

DivisionId

The unique ID for the division associated with each record.

Int32

Relations

Name

Summary

Description

Expense

This refers to the expense that this item belongs to.

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

Program

This refers to the program that this marketing entity is used in.

Campaign

This refers to the campaign that this marketing entity is used in.

Event

This is a related event.

Job

A related job for this entity.

Task

This refers to a related task.

ProjectRequest

This is a related project request.

ItemService

An item or service that this expense item was made for.

Advertisements

This is a related advertisement.

Channels

A list of related marketing channels.

RelatedPurchaseOrderItem

A purchase order item that had occurred this expense item.

When a user creates an expense for purchase order items, then the respective expense items will be related to the order item by this relation. This relation mechanic does neither guarantee to represent a complete picture and nor to be correct by accounting standards.

Department

Full details for the department associated with each record.

Division

Full details for the division associated with each record.

BusinessSegmentExpenseItems

A table of business segments that apply to the expense item.

 
Campaign  (top)

A campaign hosts multichannel marketing activities for an audience and gathers the results.

A marketing campaign is the entity that runs multichannel marketing activities in an automated way with the goal of lead generation, nurturing, scoring, and driving the end-to-end lifecycle from a prospect to sales-ready leads for the sales team. It exists in a marketing context, and defines scoring model and lead creation granularity. It contains a Campaign KPI object that delivers measures for detailed performance analysis.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

CampaignName

The name of the campaign that this marketing entity is used in.

false

128

false

String

true

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

false

Guid

BelongsToCompanyName

The name of the client or site company that owns this object.

The BelongsTo company can only be set when an object is created and cannot be changed later.

false

160

false

String

true

ProgramId

This refers to the program that this marketing entity is used in.

false

Int32

ProgramName

The name of the program that this marketing entity is used in.

false

70

String

true

CreatedByContactId

This refers to the staff contact who created this object.

Guid

Status

The status contains a value from the status category for an entity.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

250

String

true

StartDate

The start date and time for this campaign.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

EndDate

The end date and time for this campaign.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

CampaignCode

This refers to the code of the campaign.

false

50

String

true

CampaignDescription

This is descriptive text for the campaign.

false

Max

String

true

CampaignObjectives

The objectives of the campaign.

false

Max

String

true

CampaignType

This is the campaign category.

Types are used to filter, group, and sort entities. The values are defined by a category.

false

250

String

true

AutomationEnabled

This controls whether a campaign can be run automated.

This is an indicator of whether a campaign has automation enabled. It is considered True if this campaign can be run automated and has an automation model assigned. Otherwise, it is considered False.

false

Boolean

DivisionName

The name of the responsible division in the company that owns the campaign.

false

70

String

true

DepartmentName

This is the department name in the company that is responsible for this campaign.

false

70

String

true

LeadScoringModelId

This refers to the default lead scoring model used in the context of this campaign.

false

Int32

LeadScoringModelName

The name of the default lead scoring model used in the context of this campaign.

false

250

String

true

LeadCreationStrategy

The strategy of the lead creation.

This defines whether leads are created per marketing contact or marketing company.

false

250

String

true

LeadCreationScope

The scope of the lead creation.

This defines whether leads are created per campaign, program, or site company.

false

250

String

true

DivisionId

The unique ID for the division associated with each record.

false

Int32

DepartmentId

The unique ID for the department associated with each record.

false

Int32

CampaignTypeCategoryId

This is the ID for the campaign category.

Types are used to filter, group, and sort entities. The values are defined by a category.

Int32

ExternalId

This shows the external ID of the object that is typically used through the SDK.

The external ID of an object is a unique identifier (GUID) by which an object can be referenced in SDK calls.

false

Guid

Relations

Name

Summary

Description

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

Program

This refers to the program that this campaign is used in.

CreatedBy

This refers to the staff contact who created this object.

LeadScoringModel

This refers to the default lead scoring model used in the context of this campaign.

CampaignKPIs

This refers to a set of key performance indicators (KPIs) for the campaign.

Results

The table of marketing results for this campaign.

A marketing result is a record that captured an estimate and an actual value for a certain measurement, like leads generated, at a certain point in time.

CampaignResponses

The table of response models for this campaign.

A response model captures the estimated response rate over time for a certain measure, like subscriptions, and compares that to the actual recorded campaign responses.

MarketingContexts

The table of marketing contexts that exist for this campaign.

LandingPageInteractions

The table of landing page interactions associated with this campaign.

ExpenseItems

The table of expense items that occurred in the context of this campaign.

Leads

This refers to a table of leads associated with this campaign.

MarketingLists

The lookup table for static marketing lists assigned to this campaign.

This is a query finder table of the type CampaignWithMarketingLists. This allows you to find static marketing lists used in this campaign.

MarketingQueries

The lookup table for dynamic marketing lists assigned to this campaign.

This is a query finder table of the type CampaignWithMarketingQueries. This allows you to find dynamic marketing lists (Marketing Query) used in this campaign.

Division

Full details for the division associated with each record.

Department

Full details for the department associated with each record.

Events

This is a list of events related to this campaign.

Offers

The lookup table for offers that have been made in the context of this campaign.

TeamRoles

A table of team roles assumed by staff members

Approvals

Table of approval that have been created for this campaign

Regions

Table of regions that are targeted by this campaign

Brands

Table of brands which this campaign is relevant for.

CustomFields

Table of custom field values that have been saved for this Campaign

MarketSegments

Table of Market Segments that are targeted by this campaign

Channels

Table of marketing channels that are relevant in this campaign

Components

A table of components related to this campaign.

BusinessSegmentCampaigns

A table of business segments that apply to the campaign.

 
Program  (top)

Programs are used to hierarchically group marketing activities.

A marketing program is the entity that defines the highest level for grouping marketing activities under a client or site company. It contains multichannel marketing activities, is often a marketing context, and depending on that, defines scoring model and lead creation granularity. The program KPI delivers summarized measurements.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Status

The status contains a value from the status category for an entity.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

250

String

true

Name

Name of this program.

false

70

false

String

true

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

false

Guid

BelongsToCompanyName

The name of the client or site company that owns this object.

The BelongsTo company can only be set when an object is created and cannot be changed later.

false

160

false

String

true

Description

Descriptive text for this entity.

false

250

String

true

StartDate

The start date for the program.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

EndDate

The end date for this marketing program.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

Type

Types are used to filter, group, and sort entities. The values are defined by a category

Types are used to filter, group, and sort entities. The values are defined by a category.

false

250

String

true

Category

A category for the program.

The available values are defined by a category definition for this entity and this field.

false

250

String

true

DivisionName

The name of the responsible division in the company that owns the program.

false

70

String

true

DepartmentName

The name of the responsible department in the company that owns this object.

false

70

String

true

LeadScoringModelId

This refers to the default lead scoring model used in the context of this program.

false

Int32

LeadScoringModelName

The name of the default lead scoring model used in the context of this program.

false

250

String

true

DivisionId

The unique ID for the division associated with each record.

false

Int32

DepartmentId

The unique ID for the department associated with each record.

false

Int32

ExternalId

This shows the external ID of the object that is typically used through the SDK.

The external ID of an object is a unique identifier (GUID) by which an object can be referenced in SDK calls.

false

Guid

Relations

Name

Summary

Description

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

LeadScoringModel

This refers to the default lead scoring model used in the context of this program.

Leads

This refers to a table of leads that are associated to this program.

ProgramKPIs

This refers to a KPI (key performance indicator) object that contains a set of key performance indicators for this program.

Campaigns

A table of related campaigns.

MarketingContexts

A table of marketing contexts that exist for this program.

LandingPageInteractions

A table of landing page interactions associated with this marketing program.

ExpenseItems

A table of expense items that are associated with this marketing program.

Jobs

A table of jobs associated with the marketing program.

Department

Full details for the department associated with each record.

Division

Full details for the division associated with each record.

Events

A table of events associated with the marketing program.

An event can only be associated to one marketing program.

TeamRoles

A table of team roles assumed by staff members

Approvals

A table of related approvals.

Brands

A table of brands relevant for this marketing program

CustomFields

A table of user defined fields with their values for this program.

MarketSegments

A table of market segments that this program addresses

Channels

A table of marketing channels that this program addresses

BusinessSegmentPrograms

A table of business segments that apply to the program.

 
MarketingContext  (top)

A marketing context is a valid combination of a client or site company, program, and campaign.

A marketing context is a valid combination of a client or site company with a program and a campaign in which leads can be created and scored separately. An effective marketing context is defined by the lead creation strategy and lead creation scope of the respective client or site company.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

CompanyId

This refers to the company that this marketing context is used for.

false

Guid

CompanyName

The name of the company that this marketing context is used for.

false

160

false

String

true

ProgramId

This refers to the program that this marketing entity is used in.

false

Int32

ProgramName

The name of the program that this marketing entity is used in.

false

70

String

true

CampaignId

This refers to the campaign that this marketing entity is used in.

false

Int32

CampaignName

The name of the campaign that this marketing entity is used in.

false

128

String

true

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

62

false

String

true

Relations

Name

Summary

Description

Company

This refers to the client company that this marketing context is used in.

Program

This refers to the program that this marketing entity is used in.

Campaign

This refers to the campaign that this marketing entity is used in.

 
AccrualExpense  (top)

Holds records that support accrual expensing for purchase orders.

Accrual expensing is an optional feature for Dynamics Marketing, and requires a service request to activate. The feature supports monthly accrual expensing based on the 4-5-4 calendar. The records in this object supplement the standard PurchaseOrderItem object. Each record here maps to a line item in a purchase order, and adds exception, expensed, and remaining-balance values that were logged during a specified accrual period.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

PurchaseOrderId

The unique ID of the purchase order to which the accrual expense applies.

This is a foreign key value that links to the related purchase order record.

false

Int32

PurchaseOrderNumber

The user-friendly ID for the purchase order where the accrual expense applies.

This value is shown in the UI, and is unique for each purchase order. It provides a user-friendly number to help users identify purchase orders, but it isn't a foreign key value.

false

70

String

true

PurchaseOrderItemId

The unique ID for the purchase-order item to which an accrual expense applies.

This is a foreign key value that links to the related purchase-order-item record.

false

Int32

PurchaseOrderItemAmount

The total value of the purchase-order item to which the accrual expense applies.

false

Double

ExceptionAmount

The value of an exception applied by the accrual expense during the specified accrual period.

The UI shows this as the "Exception (AP)" value for a purchase-order line item during the matching accrual period. An exception is a full or partial amount of the amount on a purchase order item that is excluded from being backed up by expenses in a specific accrual report period. It decreases the balance for the period, and the exception-adjusted new balance carries forward to next period.

false

Double

ExpensedAmount

The value of an expense applied to a purchase-order item during the specified accrual period.

The UI shows this as the "Expense (AP)" value for a purchase-order line item during the matching accrual period.

false

Double

BalanceAmount

The balance of the related purchase-order item that remained at the end of the specified accrual period.

The UI shows this as the "Balance (AP)" value for a purchase-order line item during the matching accrual period.

false

Double

AccrualStartPeriod

The first date of the accrual period during which the accrual expense was applied.

DateTime

AccrualEndPeriod

The last date of the accrual period during which the accrual expense was applied.

DateTime

ExceptionComment

A user comment about an exception applied by the accrual expense during the specified accrual period.

false

Max

String

true

ExceptionNumber

The user-friendly ID for an exception.

This value is shown in the UI, and is unique for each exception. It provides a user-friendly number to help users identify exceptions, but it isn't a foreign key value.

false

70

String

true

Relations

Name

Summary

Description

PurchaseOrderItem

The purchase order item to which the accrual expense applies.

 
Account  (top)

A financial entity for grouping transactions.

An account is a financial entity that is used to group a set of financial transactions, in various types like payments or revenue. In the chart of accounts the account numbering plays an important role and defines the logical order. Budget and expense items associated with an account can be looked up here. (Other account item types are not supported yet.)

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

AccountName

The name of the account.

false

4000

String

true

AccountNumber

The number on the account.

This number identified the account. It can be set by the user.

false

70

String

true

AccountType

The type of account.

The type of account refers to what sort of account it is. This can be an asset, liability, expense, revenue payment, bank, cost of goods sold, credit card, or other type of account.

false

750

String

true

AccountDescription

This is the description of the account.

false

250

String

true

Relations

Name

Summary

Description

BudgetItems

The table of budget items that have been assigned to this account.

ExpenseItems

The table of expense items that have been assigned to this account.

EventRegistrationSetups

The table of event registration set ups that are booked under this account.

This table shows the types of available registration set ups for events. An event registration set up can cover tickets for an event and / or sessions in an event. The AR (Accounts Receivable) account for related financial transactions is this account.

 
Budget  (top)

A budget is a workbook for itemizing costs with multiple budget sheets.

A budget (workbook) allows you to define a budget using several budget sheets, each with budget items. Microsoft Dynamics Marketing budgets use the familiar paradigm of spreadsheets. For example, Microsoft Excel workbooks contain tabs; each tab is a spreadsheet. Similarly, in Microsoft Dynamics Marketing, a set of budget worksheets make up a budget workbook.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Name

The name of the budget.

false

250

false

String

true

Status

The status contains a value from the status category for an entity.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

250

String

true

Calendar

The calendar of the budget.

The standard calendar starts on January 1 and ends on December 31 each year.

false

750

String

true

TimeInterval

The standard period each budget item corresponds to.

Typical budget intervals are daily, weekly, monthly, and quarterly. A selection is required.

false

750

String

true

StartDate

The start date and time for this budget.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

EndDate

The end date and time for this budget.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

ContactId

The ID of the staff contact who is responsible for this budget.

false

Guid

DepartmentId

The unique ID for the department associated with each record.

Int32

DivisionId

The unique ID for the division associated with each record.

Int32

Relations

Name

Summary

Description

BudgetSheets

A table of related budget sheets.

BudgetKPI

This refers to a set of key performance indicators (KPIs) for the budget.

Contact

The staff contact who is responsible for this budget.

BusinessSegmentBudgets

A table of business segments assigned to the budget.

Department

Full details for the department associated with each record.

Division

Full details for the division associated with each record.

 
BudgetSheet  (top)

A budget worksheet is a portion of a budget (workbook).

A budget worksheet is like a spreadsheet for the budget for a job, campaign, event, and so on. Budget worksheets are made up of budget items. For example, the $2000 budgeted for the New Year's Eve campaign is a budget item. A budget worksheet is a set of budget items, rolled up and displayed in a spreadsheet format. Worksheets can be associated with brands, campaigns, channels, components, companies/clients, contacts, departments, events, jobs, locations, markets, media outlets, products, and programs.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

BudgetSheetName

The name of this budget sheet.

false

250

false

String

true

BudgetId

This refers to the budget that this budget sheet belongs to.

false

Int32

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

BelongsToCompanyName

The name of the client or site company that owns this object.

The BelongsTo company can only be set when an object is created and cannot be changed later.

false

160

String

true

CampaignId

This refers to the campaign that this budget is used in.

false

Int32

CampaignName

The name of the campaign that this budget is used in.

false

128

String

true

ProgramId

This refers to the program that this budget sheet is used in.

false

Int32

ProgramName

The name of the program that this marketing entity is used in.

false

70

String

true

ChannelId

This refers to the marketing channel.

false

Int32

ChannelName

The name of the marketing channel.

false

70

String

true

ComponentId

The ID for a component record that this budget sheet applies to.

false

Int32

ComponentName

The name of a component that this budget sheet applies to.

false

70

String

true

StartDate

The start date for the budget sheet.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

EndDate

The end date for the budget sheet.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

DepartmentId

The unique ID for the department associated with each record.

false

Int32

DepartmentName

The name of the department related to the budget sheet.

false

70

String

true

DivisionId

The unique ID for the division associated with each record.

false

Int32

DivisionName

The name of the division related to the budget sheet.

false

70

String

true

Relations

Name

Summary

Description

Budget

This refers to the budget that this budget sheet belongs to.

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

Campaign

This refers to the campaign that this budget sheet is used in.

Program

This refers to the program that this budget sheet is used in.

Channel

This refers to the marketing channel.

Component

Refers to the record of a component that this budget sheet applies to.

BudgetItem

This refers to the budget item that this budget sheet belongs to.

BudgetSheetKPI

Key performance indicators (KPIs) for this budget sheet.

Department

Full details for the department associated with each record.

Division

Full details for the division associated with each record.

BusinessSegmentBudgetWorksheet

A table of business segments assigned to the budget sheet.

 
BudgetItem  (top)

Budget items are the lowest level pieces that define a budget.

Each budget item is assigned an account and provides budget amounts over a period of time.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

80

false

String

true

BudgetId

The ID of the budget that this item belongs to.

false

Int32

BudgetSheetId

The ID of the budget sheet that this budget item belongs to.

false

Int32

AccountId

This refers to the account where this budget item is accounted for.

false

Int32

AccountName

The name of the account where this budget item is accounted for.

false

250

String

true

StartDate

The start date and time for this budget item.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

EndDate

The end date and time for this budget item.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

TotalBudget

The total sum of the budget amount in this budget item.

false

Double

TotalExpense

The total sum of expenses associated with this budget item.

false

Double

Relations

Name

Summary

Description

BudgetSheet

This refers to the budget sheet that this budget item belongs to.

Account

This refers to the account where this budget item is accounted for.

 
CampaignResponse  (top)

A response model defined for a campaign.

A campaign response is essentially a response model that can be used for one or more campaigns. A response model captures the estimated response rate over time for a certain measure, like subscriptions, and compares that to the actual recorded campaign responses. The feed for the campaign response contains general lead generation measures for the campaign, like total number of leads, average score, and others.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

101

false

String

true

CampaignId

This refers to the campaign that this marketing entity is used in.

false

Int32

CampaignName

The name of the campaign that this marketing entity is used in.

false

128

false

String

true

ProgramId

This refers to the program that this marketing entity is used in.

false

Int32

ProgramName

The name of the program that this marketing entity is used in.

false

70

String

true

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

BelongsToCompanyName

The name of the client or site company that owns this object.

The BelongsTo company can only be set when an object is created and cannot be changed later.

false

160

String

true

ResponseModelId

This refers to the response model.

false

Int32

ResponseModelName

The name of this response model.

false

250

false

String

true

ResponseModelDuration

The duration of the response model.

false

Int32

ResultType

The type of results that this response model looks at.

false

250

String

true

TotalLeads

The total number of leads that have been captured by the campaign.

false

Int32

UnitCost

The cost per unit in this item.

false

Double

AverageScore

The average of the score of all leads that have been generated in this campaign.

false

Double

AverageGrade

The average of the grades in which the leads that have been generated in this campaign have been placed after scoring.

false

80

String

true

Relations

Name

Summary

Description

Campaign

This refers to the campaign that this marketing entity is used in.

Program

This refers to the program that this marketing entity is used in.

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

 
Result  (top)

Results are a core source for marketing performance calculation.

A result is a recorded value for a measurement that occurred at a certain date and time, in a marketing context (client/site company, program, campaign) and for a certain result type. (If an estimate had been made for this measure, the variance can be used in performance evaluation.) A result is often related to a marketing contact, and results are recorded automatically from marketing operations, or manually by a marketer.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

ResultType

The type of measurement for this result.

For result measurement a number of out-of-box result types are delivered. The marketer can also define custom result types. Out-of-box types are: Attendees, Calls, Click-throughs, Customers, Downloads, Followers, Friends, Impressions, Inboun, Referrals, Registrations, Renewals, Revenue (per currency), Sales, Subscribers, Tweets, and Visitors

false

503

String

true

Date

The date when this item was created.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

BelongsToCompanyName

The name of the client or site company that owns this object.

The BelongsTo company can only be set when an object is created and cannot be changed later.

false

160

String

true

ContactId

This refers to the contact that this result relates to.

Guid

ContactName

The name of the contact that this result relates to.

false

200

String

true

CampaignId

This refers to the campaign that this marketing entity is used in.

false

Int32

CampaignName

The name of the campaign that this marketing entity is used in.

false

128

String

true

ProgramId

This refers to the program that this marketing entity is used in.

false

Int32

ProgramName

The name of the program that this marketing entity is used in.

false

70

String

true

EsimatedValue

The estimated value for this result.

false

Double

ActualValue

The actual value for this result.

false

Double

Variance

The variance of the actual value in relation to the estimated value.

false

Double

VariancePercent

The variance of the actual value in relation to the estimated value, in percent.

Double

EventId

The unique ID of an event associated with this entity.

Int32

EventName

The name of the event that this result relates to.

false

250

String

true

JobId

This refers to a related job for this entity.

Int32

JobName

The name of the job that this result relates to.

false

70

String

true

ChannelId

This refers to the marketing channel in which the result is relevant.

Int32

ChannelName

The name of the marketing channel for which the result is relevant.

false

70

String

true

MarketingEmailMessageId

This refers to the marketing email message that the result is related to.

Int32

MarketingEmailMessageName

The name of the marketing email message that this result relates to.

false

250

String

true

OfferId

This identifies the offer for this performance number.

Int32

Comments

Additional comments that have been entered for this result.

false

Max

String

true

ExternalId

This shows the external ID of the object that is typically used through the SDK.

The external ID of an object is a unique identifier (GUID) by which an object can be referenced in SDK calls.

false

Guid

Relations

Name

Summary

Description

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

Campaign

This refers to the campaign that this marketing entity is used in.

Program

This refers to the program that this marketing entity is used in.

Contact

The contact that this result relates to.

MarketingEmailMessage

The marketing email message that this result relates to.

Event

The event that this result relates to.

Job

The job that this result relates to.

Channel

The marketing channel in which the result is relevant.

Offer

This identifies the offer for this marketing result.

 
MarketingEmailMessage  (top)

The marketing email message is an email sent to an audience of contacts with targeted marketing content.

The marketing email message element in Microsoft Dynamics Marketing addresses multiple marketing lists with target content by segment and language. A core element for analysis is the KPI (key performance indicator) field that delivers essential performance indicators for marketing messages.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

IsActive

This indicates whether a marketing email message is active.

To use an email marketing message with a designation of Campaign Automation, it must be activated first.

false

Boolean

Designation

Usage type for the marketing email message.

The type of usage that the email marketing message has been designed for: Automation, Commercial, or Transaction.

false

750

String

true

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

false

Guid

BelongsToCompanyName

The name of the client or site company that owns this object.

The BelongsTo company can only be set when an object is created and cannot be changed later.

false

160

false

String

true

CreatedByContactId

This refers to the staff contact who created this object.

Guid

CampaignId

This refers to the campaign that this marketing entity is used in.

false

Int32

CampaignName

The name of the campaign that this marketing entity is used in.

false

128

String

true

ProgramId

This refers to the program that this marketing entity is used in.

false

Int32

ProgramName

The name of the program that this marketing entity is used in.

false

70

String

true

Subject

The subject for the message.

false

998

String

true

Status

The status contains a value from the status category for an entity.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

250

String

true

Name

The name of the email marketing message.

false

250

false

String

true

DeliveryDate

Delivery date and time of the email marketing message.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

OfferId

This refers to an offer included in the email marketing message.

false

Int32

SendRecurring

Value indicating if a marketing message is sent in recurring intervals.

false

Boolean

ExternalId

This shows the external ID of the object that is typically used through the SDK.

The external ID of an object is a unique identifier (GUID) by which an object can be referenced in SDK calls.

false

Guid

Relations

Name

Summary

Description

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

CreatedBy

This refers to the staff contact who created this object.

Campaign

This refers to the campaign that this marketing entity is used in.

Program

This refers to the program that this marketing entity is used in.

MarketingEmailMessageKPI

This provides a number of key performance indicators (KPIs) for the email marketing message.

Offer

This refers to an offer that has been included in the email marketing message.

Results

A table of tracking results that reflect email channel responses for the recipient contact's actions.

MarketingResults

A table of marketing results for this email marketing message.

Marketing results are gathered automatically as a result of certain marketing operations, entered manually by the Microsoft Dynamics Marketing user or submitted through the SDK from an external service.

 
EmailTrackingResult  (top)

Events about email marketing messages being opened, forwarded, bounced, etc.

In Microsoft Dynamics Marketing, the system tracks when a marketing email has been opened, forwarded, if it has bounced, or when the recipient has opened a link from the message. This record captures the event with the email name, its result date, and the time and type of result. The contact with its company and the marketing context is also available from this record.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int64

ContactId

This refers to the contact whose email behaviors are being captured.

Guid

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

BelongsToCompanyName

The name of the client or site company that owns this object.

The BelongsTo company can only be set when an object is created and cannot be changed later.

false

160

String

true

CompanyId

This refers to the parent company of the contact whose email behaviors are being captured.

Guid

CompanyName

The name of the parent company of the contact whose email behaviors are being captured.

false

160

String

true

ProgramId

This refers to the program the result has been captured in.

Int32

ProgramName

The name of the program the result has been captured in.

false

70

String

true

CampaignId

This refers to the campaign that this marketing entity is used in.

Int32

CampaignName

The name of the campaign that this marketing entity is used in.

false

128

String

true

Type

The type of email tracking result being reported

Result types include: click, delivered, sent, render (opened), blocked (for various reasons), failed, hard bounce, and more.

false

750

String

true

ResultDate

The date when the result was captured.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

EmailName

The name of the marketing email message in which the hard bounce occurred.

false

250

String

true

ContactName

The name of the contact whose email behaviors are being captured.

false

200

String

true

Processed

A flag indicating whether this result has already been processed.

External services are typically used to process email tracking results; for example, to handle hard bounces and update the recipient contact's email. Such an external service could use this flag to indicate that a result has already been processed and does not need to be looked at again.

false

Boolean

EmailAddress

The email address of the recipient the email has been sent to.

When an email marketing message has been sent to a recipient and a response has been captured, the email that has been used for sending that message is captured here.

false

320

String

true

MarketingEmailMessageId

This refers to the email marketing messages related to this result.

Int32

UnsubscribedFromMarketingListId

This refers to the marketing list if this event is of the Unsubscribe type.

Guid

TypeMinorContext

A value specifying a minor context under a type

false

70

String

true

Link

The link name that is relevant for the tracking result

For link clicks in email this will report the link name of the clicked link.

false

250

String

true

URL

The URL that is relevant for the tracking result

For link clicks in email this will report the URL of the clicked link.

false

2000

String

true

ExternalId

This shows the external ID of the object that is typically used through the SDK.

The external ID of an object is a unique identifier (GUID) by which an object can be referenced in SDK calls.

Guid

Relations

Name

Summary

Description

Contact

This refers to the contact whose email behaviors are being captured.

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

Company

This refers to the parent company of the contact whose email behaviors are being captured.

Program

This refers to the program result has been captured in.

Campaign

This refers to the campaign the result has been captured in.

MarketingEmailMessage

This refers to email marketing messages.

UnsubscribedFromMarketingList

This refers to the marketing list if this event is of the Unsubscribe type.

 
LandingPageInteraction  (top)

A landing page interaction stems from a marketing contact subscribing to a landing page.

This is the prominent interaction type that for the first interaction, results in the creation of a lead for a marketing company or marketing contact. Often multiple interactions are assigned to one lead for one or multiple subscribing contacts. Interactions influence the lead score and are used in lead scoring rules.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Name

The name of the interaction, which has been set by the landing page.

false

250

false

String

true

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

BelongsToCompanyName

The name of the client or site company that owns this object.

The BelongsTo company can only be set when an object is created and cannot be changed later.

false

160

String

true

CompanyId

This refers to the marketing or prospect company that this interaction has been sent from.

Guid

CompanyName

The name of the marketing or prospect company that this interaction has been sent from.

false

160

String

true

ContactId

This refers to the marketing or prospect contact that this interaction has been sent from.

Guid

ContactName

The name of the marketing or prospect contact that this interaction has been sent from.

false

200

String

true

LeadId

This refers to the lead that this interaction has been assigned to.

The lead to which an interaction is assigned depends on the lead creation strategy and lead creation scope.

false

Guid

LeadName

The name of the lead that this interaction has been assigned to, based on the lead creation strategy and lead creation scope.

false

300

false

String

true

ProgramId

This refers to the program that this marketing entity is used in.

false

Int32

ProgramName

The name of the program that this marketing entity is used in.

false

70

String

true

CampaignId

This refers to the campaign that this marketing entity is used in.

false

Int32

CampaignName

The name of the campaign that this marketing entity is used in.

false

128

String

true

Date

The date when this item was created.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

DueDate

The due date for taking action on this interaction, which comes from the landing page context.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

Priority

The priority for the interaction, which has been set by the landing page.

false

250

String

true

LandingPageUrl

The URL of the landing page.

false

Max

String

true

LandingPageName

The name of the landing page.

false

250

false

String

true

Description

Descriptive text for this entity.

false

Max

String

true

Relations

Name

Summary

Description

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

Company

This refers to the marketing or prospect company that this interaction has been sent from.

Contact

This refers to the marketing or prospect contact that this interaction has been sent from.

Lead

This refers to the lead that this interaction has been assigned to, based on the lead creation strategy and lead creation scope.

Program

This refers to the program that this marketing entity is used in.

Campaign

This refers to the campaign that this marketing entity is used in.

 
WebSite  (top)

A WebSite is the definition of a tracking instance.

A company typically defines only a few and uses them on a large amount of pages in their content management system. This allows a company to apply fine grained behavioral analysis and scoring.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Name

The name of the website.

false

70

false

String

true

Url

This is the URL of the webpage that a consumer would use to access the website.

false

Max

String

true

CreateDate

The date the website was created.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

false

Guid

BelongsToCompanyName

The name of the client or site company that owns this object.

The BelongsTo company can only be set when an object is created and cannot be changed later.

false

160

false

String

true

Type

The type of website.

Types are used to filter, group, and sort entities. The values are defined by a category.

false

250

String

true

Category

The category of this website, a value set by the marketer.

The available values are defined by a category definition for this entity and this field.

false

250

String

true

TotalVisits

The total number of visits.

The number of visits by web users to the HTML pages that have been amended with the behavioral analysis script code specific to the website.

false

Int32

TotalDuration

The total duration of visits on this website.

The duration of all visits by web users on the HTML pages that have been amended with the behavioral analysis script code specific to the website.

false

Int32

TotalPages

The total number of visited pages.

The total number of pages that have been visited by web users when visiting HTML pages that have been amended with the behavioral analysis script code specific to the website.

false

Int32

IsActive

A value indicating that the website is currently active.

Boolean

Relations

Name

Summary

Description

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

Visits

This is the table showing all visits by marketing contacts or anonymous visitors.

 
MarketingQuery  (top)

Marketing queries represent dynamic lists of contacts.

Marketing queries can either be of the subscription or suppression kind; a query always belongs to a certain level of marketing context (client/site company, program, or pampaign). Contacts are retrieved by running a query.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

BelongsToCompanyName

The name of the client or site company that owns this object.

The BelongsTo company can only be set when an object is created and cannot be changed later.

false

160

String

true

Name

The name of the marketing query.

false

128

false

String

true

Active

A value that indicates if the marketing query is currently active.

In Microsoft Dynamics Marketing many objects get soft-deleted if the marketer presses the delete button. A marketing query that has been soft-deleted is marked as "Active=false".

false

Boolean

QueryType

The Type of query determines what kind of attributes to query on.

The Type of a query decides which fields can be used to identify contacts. For example this can be contacts data, leads fields, email marketing results, web behavioral characteristics, event attendance, or membership in a marketing list.

false

750

String

true

Query

The query definition in string format.

false

Max

String

true

MarketSegmentId

Unique identifier of the related market segment for this query.

Int32

MarketSegment

The marketing segment that belongs to this marketing query.

false

70

String

true

Description

Descriptive text for this entity.

false

Max

String

true

Language

The designated language for the audience in a query.

false

250

String

true

LastRunDate

The last date and time that the query was run.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

Suppression

An indicator of whether a list is a suppression query. "True" if the list is a suppression query; otherwise, "False".

Boolean

Subscription

An indicator of whether a list is a subscription query. "True" if the list is a subscription query; otherwise, "False".

Boolean

CRMId

This refers to the ID an object has in Microsoft Dynamics CRM.

The Microsoft Dynamics Marketing Connector for Dynamics CRM synchronizes data between the two systems. For objects that have a corresponding object in Dynamics CRM, this field contains the ID for this object in Microsoft Dynamics Marketing.

Guid

ExternalId

This shows the external ID of the object that is typically used through the SDK.

The external ID of an object is a unique identifier (GUID) by which an object can be referenced in SDK calls.

false

Guid

Relations

Name

Summary

Description

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

Campaigns

A table of related campaigns.

MarketSegmentDetails

Collection of attributes that describe the details of this market segment.

This is a collection of attributes that describe the details of this market segment.

 
Invoice  (top)

An invoice record is a financial entity that is typically sent to a client for delivered marketing services.

An invoice contains a number of invoice items. It's assigned to an Accounts Receivable (AR) account, and it contains the due date and the sum of different amounts and taxes for all items. It also carries other details like currency, which is the same for all items. The invoice is typically prepared by a contact or company for another contact or company.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

BillToContactId

This refers to the contact who is billed to.

Guid

BillToCompanyId

This refers tof the company that is billed to.

Guid

InvoiceDate

The date when this invoice was issued.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

DueDate

The date when this invoice is due for payment.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

PurchaseOrderNumber

The number of the purchase order.

false

70

String

true

Terms

Legal terms that apply to this invoice.

false

250

String

true

AccountId

This refers to the Accounts Receivable (AR) account that the invoice is assigned to.

false

Int32

AccountName

The name of the Accounts Receivable (AR) account that the invoice is assigned to.

false

4000

String

true

Description

Descriptive text for this entity.

false

Max

String

true

Memo

Memo text added to the record. This text typically provides extra information and/or comments.

false

Max

String

true

PreparedByContactId

This refers to the contact that prepared the invoice.

Guid

PreparedByContactName

The name of the contact that prepared the invoice.

false

200

String

true

PreparedByCompanyId

This refers to the company that prepared the invoice.

Guid

PreparedByCompanyName

The name of the company that prepared the invoice.

false

160

String

true

BillToContactName

The name of the contact who is billed to.

false

200

String

true

BillToCompanyName

The name of the company that is billed to.

false

160

String

true

RepContactId

This refers to the contact of the sales representative.

Guid

TaxRate

Tax rate that applies to the invoice.

false

Double

CurrencyName

The name of the currency that is used for all financial numbers in this object.

The currency is a category in the system.

false

250

String

true

TotalCost

Total cost of this invoice.

false

Double

TotalTax

Total sum of taxes for this invoice.

false

Double

TotalPayments

Total sum of payments that have been made so far for this invoice.

false

Double

TotalDue

Total sum of payments due for this invoice.

false

Double

RemitToContactId

Identifies the remit to contact for this invoice

Set the remit to contact to let your customers know where to send payment for the invoice.

Guid

ShipToContactId

The contact that the respective service or product has been shipped to.

Guid

Relations

Name

Summary

Description

InvoiceItems

A table of invoice items that belong in this invoice.

RepContact

Reference to the contact of the sales representative.

RemitToContact

The contact to remit to for this invoice.

Set the remit to contact to let your customers know where to send payment for the invoice.

ShipToContact

The contact to which the respective service or product has been shipped

BillToContact

The Contact to which the Invoice is billed

PreparedByContact

The Contact who has prepared the invoice

 
InvoiceItem  (top)

An invoice item record is a financial entity that captures the invoice for only one item in a specified quantity.

An invoice item is part of an invoice. It contains the different costs and taxes for this item and carries additional details like date or currency, which are the same for all items. The budget category and the marketing context to which the item is related are also available from here.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

InvoiceId

This refers to the invoice that this item belongs to.

false

Int32

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

false

Guid

BelongsToCompanyName

The name of the client or site company that owns this object.

The BelongsTo company can only be set when an object is created and cannot be changed later.

false

160

false

String

true

Date

The date when this item was created.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

BudgetCategory

The budget category that this invoice item is associated with.

The available values are defined by a category definition for this entity and this field.

false

250

String

true

ProgramId

This refers to the program that this marketing entity is used in.

false

Int32

ProgramName

The name of the program that this marketing entity is used in.

false

70

String

true

CampaignId

This refers to the campaign that this marketing entity is used in.

false

Int32

CampaignName

The name of the campaign that this marketing entity is used in.

false

128

String

true

ComponentId

The ID of the record for a component attached to this invoice item.

false

Int32

ComponentName

The name of a component attached to this invoice item.

false

70

String

true

Quantity

The quantity of units in this item.

false

Double

UnitCost

The cost per unit in this item.

false

Double

TotalCost

The total cost of this invoice item.

false

Double

IsTaxable

A value indicating whether transactions in relation to this item or service are taxable.

false

Boolean

Description

Descriptive text for this entity.

false

Max

String

true

CurrencyName

The name of the currency that is used for all financial numbers in this object.

The currency is a category in the system.

false

250

String

true

ShippingCost

The shipping cost for this item.

false

Double

Credit

This is payment credit granted for this invoice item.

false

Double

EventId

The unique ID of an event associated with this entity.

false

Int32

JobId

This refers to a related job for this entity.

false

Int32

TaskId

This refers to a related task for this entity.

false

Int32

ProjectRequestId

This refers to a related project or job request.

false

Int32

ItemServiceId

This refers to the item or service for which this invoice line has been filed.

false

Int32

Relations

Name

Summary

Description

Invoice

This refers to the invoice that this item belongs to.

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

Program

This refers to the program that this marketing entity is used in.

Campaign

This refers to the campaign that this marketing entity is used in.

Event

An event for which the invoice item has been filed.

Job

This is a related job for this entity.

Task

This is a related task for this entity.

ProjectRequest

This is a related project or job request.

ItemService

A related item or service for which this invoice line has been filed.

Advertisements

A table of related advertisements.

Channels

A table of marketing channels that this invoice items relates to.

 
LeadScoringModel  (top)

A scoring model is a set of rules that define how a lead is scored.

The rules of a lead scoring model can take into account behavioral observations, demographic data, and marketing activities. The data exposed here contain measures like the minimum and maximum possible score and the sales-ready score.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Name

The name of the lead scoring model.

false

250

false

String

true

Active

An indicator of whether the lead scoring model is active.

false

Boolean

Type

The type of scoring model.

Types are used to filter, group and sort entities. The values are defined by a category.

false

250

String

true

MinScore

The minimum score that can be achieved with this scoring model.

Double

MaxScore

The maximum score that can be achieved with this scoring model.

Double

SalesReadyScore

The score value that indicates when a lead will be marked as ready to be taken over by the sales force.

Double

Relations

Name

Summary

Description

LeadScoringModelGrades

The table of grades that have been defined for this scoring model.

 
LeadScoringModelGrade  (top)

A scoring grade is a named score value range.

If a score model grade is marked as sales ready, and Microsoft Dynamics CRM integration has been set up, any lead that is scored in that grade will be available to sales reps in Dynamics CRM.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

101

false

String

true

LeadScoringModelId

This refers to the lead scoring model that this grade belongs to.

false

Int32

GradeName

The name of the grade.

false

250

false

String

true

From

The lower score of the grade.

false

Double

To

The upper score of the grade.

false

Double

IsSalesReady

An indicator of whether this grade is part of the sales ready score range. True if it is; otherwise, false.

Boolean

Relations

Name

Summary

Description

LeadScoringModel

This refers to the lead scoring model that this grade belongs to.

 
PurchaseOrder  (top)

Purchase orders represent purchases from vendors.

Purchase orders are created by the marketer to purchase multiple items, media, and services from vendors. In addition to the ordered items, vendor information, vendor invoice, and tracking information, this purchase order object contains the financial totals for different costs, and the relevant accounts payable.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

PurchaseOrderNumber

External number of the purchase order.

false

70

false

String

true

Description

Descriptive text for this entity.

false

Max

String

true

Terms

The legal terms that apply to this purchase order.

false

250

String

true

CreationDate

The date and time the purchase order was created.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

DueDate

The date when this purchase order is due.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

VendorContactId

This refers to the vendor contact associated with this order.

Guid

VendorContactName

The name of the vendor contact associated with this order.

false

200

String

true

VendorCompanyId

This refers to the vendor company associated with this order.

Guid

VendorCompanyName

The name of the vendor company associated with this order

false

160

String

true

VendorInvoiceNumber

The number of the invoice sent by the vendor for this expense.

false

70

String

true

TrackingNumber

The tracking number for the delivery of the ordered goods.

false

70

String

true

OrderedByContactId

This refers to the contact who ordered the items in the purchase order.

Guid

OrderedByContactName

The name of the contact who ordered items in the purchase order.

false

200

String

true

OrderedByCompanyId

This refers to the company that ordered the items in the purchase order.

Guid

OrderedByCompanyName

The name of the company that ordered the items in the purchase order.

false

160

String

true

OrderedForContactId

This refers to the contact for which the items in this purchase order were ordered.

Guid

OrderedForContactName

The name of the contact for which the items in this purchase order were ordered.

false

200

String

true

OrderedForCompanyId

This refers to the company for which the items in this purchase order were ordered.

Guid

OrderedForCompanyName

The name of the company for which the items in this purchase order were ordered.

false

160

String

true

TotalCost

The total cost of this quote item.

false

Double

ShippingCost

The shipping cost for the items in the purchase order.

false

Double

TotalQuantity

The total quantity of items covered by this purchase order.

false

Double

CurrencyName

The type of currency used for all financial numbers in this object.

The currency is a category in the system.

false

250

String

true

AccountId

This refers to the account that handles purchase orders.

false

Int32

AccountName

The name of the account that handles purchase orders.

false

4000

String

true

Status

The status contains a value from the status category for an entity.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

250

String

true

TaxRate

The tax rate that applies to the purchase order.

false

Double

TotalTax

The total sum of taxes for this invoice.

false

Double

Memo

Memo text added to the record. This text typically provides extra information and/or comments.

false

Max

String

true

VendorTrackingNumber

External tracking number related to the vendor for this order.

false

70

String

true

ClientPurchaseOrderNumber

Purchase order number for the client.

false

70

String

true

Relations

Name

Summary

Description

VendorContact

This refers to the vendor contact associated with this order.

VendorCompany

This refers to the vendor company associated with this order.

PurchaseOrderItems

A table of items that have been ordered as part of this purchase order.

Expenses

A table of related expenses.

The related expenses contain one or more expense items that correspond to one or more purchase order items.

 
PurchaseOrderItem  (top)

Purchase order items represent items to purchase from vendors.

A purchase order is created by the marketer to buy one or more items, media, or services from one vendor. This feed table is used for one kind of ordered item, and contains quantity and different costs for one item.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

PurchaseOrderId

This refers to the purchase order.

false

Int32

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

false

Guid

BelongsToCompanyName

The name of the client or site company that owns this object.

The BelongsTo company can only be set when an object is created and cannot be changed later.

false

160

false

String

true

Date

The date when this item was created.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

Description

Descriptive text for this entity.

false

Max

String

true

ProgramId

This refers to the program that this marketing entity is used in.

false

Int32

ProgramName

The name of the program that this marketing entity is used in.

false

70

String

true

CampaignId

This refers to the campaign that this marketing entity is used in.

false

Int32

CampaignName

The name of the campaign that this marketing entity is used in.

false

128

String

true

ComponentName

The name of a component related to this purchase order item.

false

70

String

true

ComponentId

The ID for a component record related to this purchase order item.

false

Int32

AccountId

This refers to the account associated with a purchase order item.

false

Int32

AccountName

Name of the Account in which this financial Item is accounted for.

false

4000

String

true

BudgetCategory

The category in the budget associated with this item.

The available values are defined by a category definition for this entity and this field.

false

250

String

true

CurrencyName

The name of the currency used for all financial numbers in this object.

The currency is a category in the system.

false

250

String

true

Quantity

The quantity of units in this item.

false

Double

ShippingCost

The shipping cost for this item.

false

Double

Credit

Payment credit granted for this item.

false

Double

UnitCost

The cost per unit for this item.

false

Double

TotalCost

The total cost of this purchase order tem.

false

Double

IsTaxable

A value indicating whether this purchase order item is taxable.

false

Boolean

EventId

The unique ID of an event associated with this entity.

false

Int32

JobId

This refers to a related job for this entity.

false

Int32

TaskId

This refers to a related task for this entity.

false

Int32

ProjectRequestId

This refers to a related project request.

false

Int32

ItemServiceId

This refers to a related item service.

false

Int32

Expensed

The total value already expensed for this line item

false

Double

Balance

The total value not yet expensed for this line item

false

Double

ExpensedFilled

Value indicating whether this item has been expensed

When an expense item is created for a purchase order item the latter will be marked as expensed in this field.

false

Int16

Relations

Name

Summary

Description

PurchaseOrder

This refers to a related purchase order.

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

Program

This refers to the program that this marketing entity is used in.

Campaign

This refers to the campaign that this purchase order item is used in.

Event

This refers to the event that this purchase order item is used in.

Job

This is a related job for this entity.

Task

A related task for this entity.

ProjectRequest

This refers to a related project request.

ItemService

This refers to a related item or service.

Advertisements

A table of advertisements related to this entity.

Channels

A table of channels related to this entity.

RelatedExpenseItems

A table of expense items that has been created for this purchase order item.

When a user creates an expense for purchase order items, then the respective expense items will be related to the order item . This relation mechanic does neither guarantee to represent a complete picture and nor to be correct by accounting standards.

AccrualExpenses

A table of accrual expenses and exceptions that apply to the purchase order item.

Each accrual expense or exception represents an expense or exception that occurred during a specific accrual period. Accrual expensing is an optional feature for Dynamics Marketing, and requires a service request to activate.

 
ClientQuote  (top)

A client quote is a quote for items and services for a client.

Use client quotes to provide quotes for items and services to a client. Sales orders can be created easily from quotes and are used to track orders from clients prior to their being invoiced. Quotes and sales orders are similar to invoices but don't post to the general ledger. Note: In Microsoft Dynamics Marketing 2015, sales orders aren't exposed through OData feeds.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Description

Descriptive text for this entity.

false

Max

String

true

Memo

Memo text added to the record. This text typically provides extra information and/or comments.

false

Max

String

true

Status

The status contains a value from the status category for an entity.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

250

String

true

Terms

The terms that apply for this quote.

false

250

String

true

PreparedDate

The date and time that the quote was prepared.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

RequestedDate

The date and time that the quote was requested.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

RepContactId

The ID of the Sales Rep contact.

Guid

PreparedByContactId

This refers to the contact who prepared the quote.

Guid

PreparedByContactName

The display name of the contact who prepared the quote.

false

200

String

true

PreparedByCompanyId

This refers to the company that prepared the quote.

Guid

PreparedByCompanyName

The name of the company that prepared the quote.

false

160

String

true

PreparedForContactId

This refers to the contact for whom the quote has been prepared.

Guid

PreparedForContactName

The display name of the contact for whom the quote has been prepared.

false

200

String

true

PreparedForCompanyId

This refers to the company for which the quote has been prepared.

Guid

PreparedForCompanyName

The name of the company for which the quote was prepared.

false

160

String

true

TaxRate

The tax rate that applies to the purchase of the quoted items and services.

The tax rate is the same for all quote items.

false

Double

TotalCost

The total cost of this quote item.

false

Double

TotalTax

The total amount of tax to be paid for the quoted items and services.

false

Double

ShippingCost

The shipping cost for this item.

false

Double

TotalQuantity

The total quantity of items covered by this quote.

false

Double

CurrencyName

The name of the currency used for all financial numbers in this object.

The currency is a category in the system.

false

250

String

true

Relations

Name

Summary

Description

ClientQuoteItems

The table of items included in a quote.

RepContact

This refers to the Sales Rep contact.

 
ClientQuoteItem  (top)

Client quote items are used when providing quotes for items and services to a client.

This feed table is used for one kind of quoted item, and contains the quantity and different costs for one item.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

QuoteId

This refers to the quote that this item belongs to.

false

Int32

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

false

Guid

BelongsToCompanyName

The name of the client or site company that owns this object.

The BelongsTo company can only be set when an object is created and cannot be changed later.

false

160

false

String

true

Date

The date when this item was created.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

Description

Descriptive text for this entity.

false

Max

String

true

ProgramId

This refers to the program that this marketing entity is used in.

false

Int32

ProgramName

The name of the program that this marketing entity is used in.

false

70

String

true

CampaignId

This refers to the campaign that this marketing entity is used in.

false

Int32

CampaignName

The name of the campaign that this marketing entity is used in.

false

128

String

true

BudgetCategory

The budget category this item is associated with.

The available values are defined by a category definition for this entity and this field.

false

250

String

true

CurrencyName

The name of the currency used for all financial numbers in this object.

The currency is a category in the system.

false

250

String

true

Quantity

The quantity of units in this item.

false

Double

ShippingCost

The shipping cost for this item.

false

Double

Credit

The payment credit granted for this item.

false

Double

UnitCost

The cost per unit of this item.

false

Double

TotalCost

The total cost of this quote item.

false

Double

IsTaxable

The value indicating whether transactions in relation to this item or service are taxable.

false

Boolean

EventId

The unique ID of an event associated with this entity.

false

Int32

JobId

This refers to a related job for this client quote.

false

Int32

TaskId

This refers to a related task for this entity.

false

Int32

ProjectRequestId

This refers to a related project request for this entity.

false

Int32

ItemServiceId

This refers to a related item or service for this client quote.

false

Int32

Relations

Name

Summary

Description

ClientQuote

This refers to the parent client quote.

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

Program

This refers to the program that this marketing entity is used in.

Campaign

This refers to the campaign that this marketing entity is used in.

Event

This is a related event for this entity.

Job

This is a related job for this entity.

Task

This is a related task for this entity.

ProjectRequest

This is a related project request for this entity.

ItemService

This is a related item or service for this entity.

Advertisements

This is a table of related advertisements.

Channels

This is a table of related marketing channels.

 
MarketingList  (top)

Marketing lists are static lists of contacts.

Contacts in the list are managed manually by the marketer, or can be created interactively by the marketer from a dynamic marketing query. The list can be a subscription or suppression list, which will then reflect in subscription centers. A list always belongs to a certain level of marketing context (client/site company, program, or campaign).

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Guid

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

BelongsToCompanyName

The name of the client or site company that owns this object.

The BelongsTo company can only be set when an object is created and cannot be changed later.

false

160

String

true

ContactCount

The number of contacts in this list.

Int32

Name

The name of the marketing list.

false

128

false

String

true

Active

A value indicating if the marketing list is currently active.

In Microsoft Dynamics Marketing many objects get soft-deleted if the marketer presses the delete button. A marketing list that has been soft-deleted is marked as "Active=false".

false

Boolean

MarketSegmentId

Unique identifier of the market segment that's targeted by this marketing list.

Int32

MarketSegment

Market segment that's targeted by this marketing list.

false

70

String

true

SuppressionList

An indicator of whether this list is a suppression list. "True" if this list is a suppression list; otherwise, "False".

Boolean

SubscriptionList

An indicator of whether this list is a subscription list. If the list is a subscription list, the it is "True"; otherwise, it is "False".

Boolean

Description

Descriptive text for this entity.

false

Max

String

true

Language

The language used for the audience in this list.

false

250

String

true

Type

This is the type of marketing list.

In Microsoft Dynamics Marketing, marketing lists can be of the following types: "List", "Query", "Email List (Rented)", or "Mailing List (Rented)". This feed returns only lists of the type "List".

false

750

String

true

CRMId

This refers to the Microsoft Dynamics CRM identifier in the marketing list.

The Microsoft Dynamics Marketing Connector for Microsoft Dynamics CRM synchronizes data between the two systems. For objects that have a corresponding object in Microsoft Dynamics Marketing, this field contains the unique ID for this object in Microsoft Dynamics CRM.

Guid

ExternalId

This shows the external ID of the object that is typically used through the SDK.

The external ID of an object is a unique identifier (GUID) by which an object can be referenced in SDK calls.

false

Guid

Relations

Name

Summary

Description

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

MarketingListWithContacts

This refers an object that allows you to find marketing lists that contain certain contacts.

MarketingEmailsForMarketingLists

This refers to an object that allows you to find marketing messages that use this marketing list.

Campaigns

A table of related campaigns.

MarketSegmentDetails

Details about the market segment that's targeted by this marketing list.

 
CampaignKPI  (top)

The KPI (key performance indicator) object delivers a set of aggregated measures for the campaign.

A marketing campaign is the entity that runs multichannel marketing activities in an automated way with the goal of lead generation, nurturing, scoring, and driving the end-to-end lifecycle from a prospect to sales-ready leads for the sales team. This KPI object is part of it and delivers a set of aggregated measures for detailed performance analysis. KPIs are reported using the following terms: Actual (displays the total quantity of a certain measure and are typically specified in marketing results); Estimate (specifies the estimated quantity of a certain measure and are typically specified in marketing results); Variance (displays the total actual divided by the total estimate for a certain measure; for example, if you estimated 100 sales and got 110, the variance would be 10); Variance % (displays the total actual divided by the total estimate for a certain measure in percent; for example, if you estimated 100 sales and got 110, the variance % would be 110%); MCP (Medium Cost Point; Total Costs / Measure Actual Value); MCP Variance (variance of Medium Cost Point from the estimate for unit); Cost ((Total Costs / Measure Actual Value) - Estimated Unit Cost).

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

CurrencyName

The name of the currency that is used for all financial numbers in this object.

The currency is a category in the system.

false

250

String

true

ExpenseTotal

The total of all expenses.

false

Double

PurchaseOrderTotal

The sum amount of all purchase orders.

false

Double

PurchaseOrderVariance

The purchase order volume variance from the estimate.

(Total Cost / Number of purchase orders) - Estimated Unit Cost.

false

Double

EstimateTotal

The total estimated amount of expenses.

false

Double

InvoiceTotal

The total amount from invoices, for the KPI currency, in the context of the campaign.

false

Double

DirectLaborTotal

The total amount of cost for direct labor, for this KPI's currency, in the context of the campaign.

false

Double

PaymentTotal

The total amount of payments, for this KPI's currency, in the context of the campaign.

false

Double

BalanceDue

The total amount of expenses due that occurred for this campaign.

false

Double

Profit

The amount of profit made from the campaign.

This is calculated by (InvoiceTotal - DirectLaborTotal - ExpenseTotal).

false

Double

ProfitPercentage

The profit made from the campaign in relation to the total expenses.

This is calculated by (Profit/ExpenseTotal).

false

Double

TargetQuantity

The overall numeric target quantity value for the campaign used in the denominator for the response rate calculation.

false

Double

TotalCost

This is the total cost of the quote item.

Double

ConversionRate

The rate of conversion in the number of sales in relation to the number of leads from this campaign.

false

Double

ResponseRate

The number of leads in relation to the target quantity.

Double

OrderRate

The number of orders in relation to the number of prospects.

false

Double

ROMI

The actual value for the return on marketing investment (ROMI) is the revenue per total cost.

Double

FollowersActual

The number of followers registered in the context of the campaign.

Double

FollowersMCP

This represents the number of followers - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

FollowersMCPVariance

The number of followers - medium cost point (MCP) variance from estimated unit cost.

(Total Cost / Number of followers) - Estimated Unit Cost.

Double

LeadsActual

The number of leads registered in the context of the campaign.

Double

LeadsMCP

The number of leads - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

LeadsMCPVariance

The number of leads - medium cost point (MCP) variance from the estimated unit cost.

(Total Cost / Number of leads) - Estimated Unit Cost.

Double

RevenueActual

The amount of revenue achieved for this KPI's currency, in the context of the campaign.

Double

RevenueMCP

This is the amount of revenue - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Revenue).

Double

RevenueMCPVariance

This is the amount of revenue - medium cost point (MCP) variance from the estimated unit cost.

(Total Cost / Measure Actual Value) - Estimated Unit Cost.

Double

ROMIPercentActual

The actual return on marketing investment (ROMI) by percent.

Double

ROMIPercentMCP

This is the return on marketing investment (ROMI) by percent - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

ROMIPercentMCPVariance

This is the return on marketing investment (ROMI) in percent - medium cost point (MCP) variance from the estimated unit cost.

(Total Cost / Measure Actual Value) - Estimated Unit Cost.

Double

SalesActual

The amount of sales that have been closed for this KPI's currency, in the context of the campaign.

Double

SalesMCP

This is the amount of sales - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

SalesMCPVariance

This is the amount of sales - medium cost point (MCP) variance from the estimated unit cost.

(Total Cost / Measure Actual Value) - Estimated Unit Cost.

Double

ToplineRevenueActual

The actual amount of the top-line / gross revenue.

Double

ToplineRevenueMCP

This is the top-line revenue - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

ToplineRevenueMCPVariance

This is the top-line revenue - medium cost point (MCP) variance from the estimated unit cost.

(Total Cost / Measure Actual Value) - Estimated Unit Cost.

Double

TweetsActual

The number of tweets registered in the context of the campaign.

Double

TweetsMCP

This is the number of tweets - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

TweetsMCPVariance

This is the number of tweets - medium cost point (MCP) variance from the estimated unit cost.

(Total Cost / Measure Actual Value) - Estimated Unit Cost.

Double

CustomersActual

The number of customers in the context of the campaign.

Double

CustomersMCP

This is the number of customers - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

CustomersMCPVariance

The number of customers - the medium cost point (MCP) variance from the estimated unit cost.

(Total Cost / Number of Customers) - Estimated Unit Cost.

Double

OrdersActual

The actual number of orders generated from of this marketing campaign.

Double

OrdersMCP

The number of orders - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

OrdersMCPVariance

The number of orders - the medium cost point (MCP) variance from the estimated unit cost.

(Total Cost / Number of orders) - Estimated Unit Cost

Double

CallsActual

The number of calls registered in the context of the campaign.

Double

CallsMCP

This is the number of calls - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

CallsMCPVariance

The number of calls - medium cost point variance from estimated unit cost.

(Total Cost / Number of Calls) - Estimated Unit Cost.

Double

ClickThroughsActual

Total number of click throughs.

The number of click throughs for this campaign.

Double

ClickThroughsMCP

This is the number of click-throughs - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

ClickThroughsMCPVariance

This is the number of click-throughs - medium cost point variance from estimated unit cost.

(Total Cost / Measure Actual Value) - Estimated Unit Cost.

Double

SubscriberActual

Total number of subscribers.

The total number of subscribers for this campaign.

Double

SubscriberMCP

This is the number of subscribers - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

SubscriberMCPVariance

This is the number of subscribers - medium cost point variance from estimated unit cost.

(Total Cost / Measure Actual Value) - Estimated Unit Cost.

Double

AttendeesActual

Total number of attendees.

The number of attendees for this campaign.

Double

AttendeesMCP

This is the number of attendees - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

AttendeesMCPVariance

This is the number of attendees - medium cost point variance from estimated unit cost.

(Total Cost / Measure Actual Value) - Estimated Unit Cost.

Double

RegistrationActual

Total number of registrations.

The total number of registrations for this campaign.

Double

RegistrationMCP

This is the number of registrations - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

RegistrationMCPVariance

This is the number of registrations - medium cost point variance from estimated unit cost.

(Total Cost / Measure Actual Value) - Estimated Unit Cost.

Double

RenewalsActual

Total number of renewals.

The total number of renewals for this campaign.

Double

RenewalsMCP

This is the number of renewals - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

RenewalsMCPVariance

The number of renewals - medium cost point variance from estimated unit cost.

The number of renewals where the (Total Cost / Measure Actual Value) - Estimated Unit Cost.

Double

DownloadsActual

Total number of downloads.

The total number of downloads for this campaign.

Double

DownloadsMCP

This is the is the number of downloads - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

DownloadsMCPVariance

This is the number of downloads - medium cost point variance from estimated unit cost.

(Total Cost / Measure Actual Value) - Estimated Unit Cost.

Double

ProspectsActual

Total number of prospects.

The total number of prospects for this campaign.

Double

ProspectsMCP

This is the number of prospects - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

ProspectsMCPVariance

This is the number of prospects - medium cost point variance from estimated unit cost.

(Total Cost / Measure Actual Value) - Estimated Unit Cost.

Double

VisitorsActual

Total number of visitors.

The total number of visitors for this campaign.

Double

VisitorsMCP

This is the number of visitors - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

VisitorsMCPVariance

This is the number of visitors - medium cost point variance from estimated unit cost.

(Total Cost / Measure Actual Value) - Estimated Unit Cost.

Double

ImpressionsActual

Total number of impressions.

The total number of impressions for this campaign.

Double

ImpressionsMCP

This is the number of impressions - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

ImpressionsMCPVariance

This is the number of impressions - medium cost point variance from estimated unit cost.

(Total Cost / Measure Actual Value) - Estimated Unit Cost.

Double

ReferralsActual

Total number of referrals.

The total number of referrals for this campaign.

Double

ReferralsMCP

This is the number of referrals - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

ReferralsMCPVariance

This is the number of referrals - medium cost point variance from estimated unit cost.

(Total Cost / Measure Actual Value) - Estimated Unit Cost.

Double

InboundLinksActual

Total number of inbound link clicks

The total number of inbound link clicks for this campaign.

Double

InboundLinksMCP

This is the number of inbound links - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

InboundLinksMCPVariance

This is the number of inbound links - medium cost point variance from estimated unit cost.

(Total Cost / Measure Actual Value) - Estimated Unit Cost.

Double

FriendsActual

Total number of friends.

The total number of friends for this campaign.

Double

FriendsMCP

This is the number of friends - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

FriendsMCPVariance

This is the number of friends - medium cost point variance from estimated unit cost.

(Total Cost / Measure Actual Value) - Estimated Unit Cost.

Double

PostsActual

Total number of posts.

The total number of posts for this campaign.

Double

PostsMCP

This is the number of posts - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

PostsMCPVariance

This is the number of posts - medium cost point variance from estimated unit cost.

(Total Cost / Measure Actual Value) - Estimated Unit Cost.

Double

LetterFaxActual

Total number of fax letters.

The total number of fax letters for this campaign.

Double

LetterFaxMCP

This is the number of faxes - medium cost point (MCP).

MCP: Medium Cost Point (Total Costs / Measure Actual Value).

Double

LetterFaxMCPVariance

This is the number of faxes - medium cost point variance from estimated unit cost.

(Total Cost / Measure Actual Value) - Estimated Unit Cost.

Double

Relations

Name

Summary

Description

Campaign

This refers to the campaign that this marketing entity is used in.

 
MarketingEmailMessageKPI  (top)

This is a set of key performance indicators (KPIs) for an email marketing message.

Many key performance indicators (KPIs) for an email marketing message can be classified by the following types: Actual (displays the total quantity of a certain measure); Estimate (specifies the estimated quantity of a certain measure); Variance (displays the total actual divided by the total estimate for a certain measure (for example, if you estimated 100 sales and got 110, the variance would be 10)); Variance % (displays the total actual divided by the total estimate for a certain measure in percent (for example, if you estimated 100 sales and got 110, the variance % would be 110%)).

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

SentActual

The number of messages actually sent, as a result of various rules.

false

Double

SentActualPercent

The percentage of messages actually sent, as a result of various rules.

false

Double

SentEstimate

The estimate of the number of messages that would actually be sent after applying various rules.

false

Double

SentEstimatePercent

The percentage estimate of the number of messages that would actually be sent after applying various rules.

false

Double

SentVariance

The variance for sent messages: Actual versus Estimated.

false

Double

SentVariancePercent

The variance in percent for sent messages: Actual versus Estimated.

false

Double

DeliveredActual

The number of messages actually delivered.

false

Double

DeliveredActualPercent

The number of messages actually delivered in percent.

false

Double

DeliveredEstimate

The estimated number of delivered messages.

false

Double

DeliveredEstimatePercent

The estimated percentage of delivered messages.

false

Double

DeliveredVariance

The variance for delivered messages: Actual versus Estimated.

false

Double

DeliveredVariancePercent

Variance in percent for delivered messages: Actual versus Estimated.

false

Double

OpenedActual

The number of messages actually opened by the receiver.

Opening an email message is recorded if the user views and downloads the pictures in the message.

false

Double

OpenedActualPercent

The percentage of messages that have actually been opened by the receiver.

The percentage of messages that have actually been opened by the receiver is relative to the number of actual sent messages. Use this indicator to measure the effectiveness of your email marketing campaign in terms of how inclined the target audience is to open email messages. Opening an email message is recorded if the user views and downloads the pictures in the message.

false

Double

OpenedEstimate

The estimate for the number of messages opened by the receiver.

Opening an email message is recorded if the user views and downloads the pictures in the message.

false

Double

OpenedEstimatePercent

The percentage of messages opened by the receiver.

The percentage of messages opened by the receiver is based on the estimated opened amount relative to the number of actual sent messages. Use this indicator to measure the effectiveness of your email marketing campaign in terms of how inclined the target audience is to open email messages. Opening an email message is recorded if the user views and downloads the pictures in the message.

false

Double

OpenedVariance

The variance for opened messages: Actual versus Estimated.

false

Double

OpenedVariancePercent

The variance in percent for opened messages: Actual versus Estimated.

false

Double

UniqueClicksActual

The number of unique clicks on tracked links in the email marketing message.

false

Double

UniqueClicksActualPercent

The percentage of unique clicks on tracked links in the email marketing message.

false

Double

UniqueClicksEstimate

The estimate for the number of unique clicks on tracked links in the email marketing message.

false

Double

UniqueClicksEstimatePercent

The percentage estimate for the number of unique clicks on tracked links in the email marketing message.

false

Double

UniqueClicksVariance

The variance for unique clicks in messages: Actual versus Estimated.

false

Double

UniqueClicksVariancePercent

The variance in percent for unique clicks in messages: Actual versus Estimated.

false

Double

TotalClicksActual

The total number of clicks on tracked links in the email marketing message.

false

Double

TotalClicksActualPercent

The total percentage of clicks on tracked links in the email marketing message.

false

Double

TotalClicksEstimate

The estimate for the total number of clicks on tracked links in the email marketing message.

false

Double

TotalClicksEstimatePercent

The percentage estimate for the total number of clicks on tracked links in the email marketing message.

false

Double

TotalClicksVariance

The variance for total number of clicks in messages: Actual versus Estimated.

false

Double

TotalClicksVariancePercent

The variance in percent for total number of clicks in messages: Actual versus Estimated.

false

Double

HardBouncesActual

The actual number of hard bounced messages.

A hard bounce is an email message that has been returned to the sender because the recipient's address is invalid.

false

Double

HardBouncesActualPercent

The percentage of hard bounced messages relative to the number of messages sent.

A hard bounce is an email message that has been returned to the sender because the recipient's address is invalid.

false

Double

HardBouncesEstimate

The estimated number of hard bounced messages.

A hard bounce is an email message that has been returned to the sender because the recipient's address is invalid.

false

Double

HardBouncesEstimatePercent

The estimated percent of hard bounced messages of the messages sent.

A hard bounce is an email message that has been returned to the sender because the recipient's address is invalid.

false

Double

HardBouncesVariance

The variance for hard bounced messages: Actual versus Estimated.

A hard bounce is an email message that has been returned to the sender because the recipient's address is invalid.

false

Double

HardBouncesVariancePercent

The variance in percent for hard bounced messages: Actual versus Estimated.

A hard bounce is an email message that has been returned to the sender because the recipient's address is invalid.

false

Double

SoftBouncesActual

The actual number of soft bounced messages.

A soft bounce will be reported if an email message that got delivered to the recipient's mail server bounced back undelivered before it got to the recipient. A typical reason for a soft bounce is that the recipient's inbox is full. Even though a soft bounce had occurred, the message may still be delivered at another time, or forwarded to a different email address for the recipient.

false

Double

SoftBouncesActualPercent

The percentage of soft bounced messages relative to the number of message sent.

A soft bounce will be reported if an email message that got delivered to the recipient's mail server bounced back undelivered before it got to the recipient. A typical reason for a soft bounce is that the recipient's inbox is full. Even though a soft bounce had occurred, the message may still be deliverable at another time, or forwarded to a different email address of the recipient.

false

Double

SoftBouncesEstimate

The estimated number of soft bounced messages.

A soft bounce will be reported if an email message that got delivered to the recipient's mail server bounced back undelivered before it got to the recipient. A typical reason for a soft bounce is that the recipient's inbox is full. Even though a soft bounce had occurred, the message may still be delivered at another time, or forwarded to a different email address for the recipient.

false

Double

SoftBouncesEstimatePercent

The estimated percentage of soft bounced messages compared to the estimated sent messages.

A soft bounce will be reported if an email message that got delivered to the recipient's mail server bounced back undelivered before it got to the recipient. A typical reason for a soft bounce is that the recipient's inbox is full. Even though a soft bounce had occurred, the message may still be delivered at another time, or forwarded to a different email address for the recipient.

false

Double

SoftBouncesVariance

The variance for soft bounced messages: Actual versus Estimated.

A soft bounce will be reported if an email message that got delivered to the recipient's mail server bounced back undelivered before it got to the recipient. A typical reason for a soft bounce is that the recipient's inbox is full. Even though a soft bounce had occurred, the message may still be delivered at another time, or forwarded to a different email address for the recipient.

false

Double

SoftBouncesVariancePercent

The variance in percent for soft bounced messages: Actual versus Estimated.

A soft bounce will be reported if an email message that got delivered to the recipient's mail server bounced back undelivered before it got to the recipient. A typical reason for a soft bounce is that the recipient's inbox is full. Even though a soft bounce had occurred, the message may still be delivered at another time, or forwarded to a different email address for the recipient.

false

Double

ForwardsActual

The number of forwarded messages.

false

Double

ForwardsActualPercent

The percentage of forwarded messages relative to the number of messages sent.

false

Double

ForwardsEstimate

The estimated number of forwarded messages.

false

Double

ForwardsEstimatePercent

The estimated percentage of forwarded messages compared to the estimated sent messages.

false

Double

ForwardsVariance

The variance for forwarded messages: Actual versus Estimated.

false

Double

ForwardsVariancePercent

The variance in percent for forwarded messages: Actual versus Estimated.

false

Double

UnsubscribesActual

The absolute number of "unsubscribes".

false

Double

UnsubscribesActualPercent

The percentage of "unsubscribes" relative to the number of messages sent.

false

Double

UnsubscribesEstimate

The estimated number of "unsubscribes".

false

Double

UnsubscribesEstimatePercent

The estimated percentage of "unsubscribes".

false

Double

UnsubscribesVariance

The variance for "unsubscribes": Actual versus Estimated.

false

Double

UnsubscribesVariancePercent

The variance in percent for "unsubscribes": Actual versus Estimated.

false

Double

LeadsActual

The number of captured leads.

false

Double

LeadsActualPercent

The percentage of captured leads relative to the number of message sent.

false

Double

LeadsEstimate

The estimated number of captured leads.

false

Double

LeadsEstimatePercent

The estimated percentage of captured leads of the number of messages.

false

Double

LeadsVariance

The variance for captured leads: Actual versus Estimated.

false

Double

LeadsVariancePercent

The variance in percent of capture leads: Actual versus Estimated.

false

Double

BlockedActual

The number of (cross campaign rule) blocked messages.

Messages may be blocked by Microsoft Dynamics Marketing as a result of active cross campaign rules.

false

Double

BlockedActualPercent

The percentage of (cross campaign rule) blocked messages relative to the number of message sent.

Messages may be blocked by Microsoft Dynamics Marketing as a result of active cross campaign rules.

false

Double

BlockedEstimate

The estimated number of (cross campaign rule) blocked messages.

Messages may be blocked by Microsoft Dynamics Marketing as a result of active cross campaign rules.

false

Double

BlockedEstimatePercent

The estimated percentage of (cross campaign rule) blocked messages.

Messages may be blocked by Microsoft Dynamics Marketing as a result of active cross campaign rules.

false

Double

BlockedVariance

The variance for (cross campaign rule) blocked messages: actual vs. estimated.

Messages may be blocked by Microsoft Dynamics Marketing as a result of active cross campaign rules.

false

Double

BlockedVariancePercent

The variance in (cross campaign rule) percent for blocked messages: Actual vs. Estimated.

Messages may be blocked by Microsoft Dynamics Marketing as a result of active cross campaign rules.

false

Double

BlockedDueToContactabilityActual

The number of (contactable) blocked messages.

Whether a contact can be emailed is controlled by their opt in/out status and whether they have been included in the global suppression list.

false

Double

BlockedDueToContactabilityActualPercent

The number of (contactable) blocked messages by percent.

Whether a contact can be emailed is controlled by their opt in/out status and whether they have been included in a global suppression list.

false

Double

BlockedDueToContactabilityEstimate

An estimate of the number of (contactable) blocked messages.

Whether a contact can be emailed is controlled by their opt in/out status and whether they have been included in the global suppression list.

false

Double

BlockedDueToContactabilityEstimatePercent

An estimate of the number of (contactable) blocked messages by percent.

Whether a contact can emailed is controlled by their opt in/out status and whether they have been included in the global suppression list.

false

Double

BlockedDueToContactabilityVariance

The number of (contactable) blocked messages: Actual vs. Estimated.

Whether a contact can emailed is controlled by their opt in/out status and whether they have been included in the global suppression list.

false

Double

BlockedDueToContactabilityVariancePercent

The number of (contactable) blocked messages by percent: Actual vs. Estimated.

Whether a contact can emailed is controlled by their opt in/out status and whether they have been included in the global suppression list.

false

Double

BlockedDueToDeduplicationEngine

Number of blocked contacts due to duplicate contact matching rules.

false

Double

BlockedDueToDeduplicationEnginePercent

Number of blocked contacts due to duplicate contact matching rules in percent.

false

Double

BlockedDueToMissingEmail

Number of blocked email due to contact not having an email address.

false

Double

BlockedDueToMissingEmailPercent

Number of blocked email due to contact not having an email address, in percent.

false

Double

BlockedDueToDoNotEmail

Number of blocked email due to the contacts communication choice to not receive emails.

false

Double

BlockedDueToDoNotEmailPercent

Number of blocked email due to the contacts communication choice to not receive emails, in percent.

false

Double

BlockedDueToContactNotActive

Number of blocked email due to contact not being active.

false

Double

BlockedDueToContactNotActivePercent

Number of blocked email due to contact not being active in percent.

false

Double

Relations

Name

Summary

Description

MarketingEmailMessage

This refers to the email message for this key performance indicator (KPI).

 
ProgramKPI  (top)

The program key performance indicator (KPI) delivers summarized measurements for a program.

Each record here contains a collection of KPIs related to a specific program.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

CurrencyName

The name of the currency that is used for all financial numbers in this object.

The currency is a category in the system.

false

250

String

true

ExpenseTotal

The total amount of all expenses for this KPI's currency, in the context of the program.

false

Double

PurchaseOrderTotal

The total amount of purchase orders for this KPI's currency, in the context of the program.

false

Double

EstimateTotal

The estimated total for this KPI's currency, in the context of the program.

false

Double

InvoiceTotal

The total amount from invoices for this KPI's currency, in the context of the program.

false

Double

DirectLaborTotal

The total amount for direct labor in this KPI's currency, in the context of the program.

false

Double

PaymentTotal

The total amount of payments for this KPI's currency, in the context of the program.

false

Double

Relations

Name

Summary

Description

Program

This refers to the program that this marketing entity is used in.

 
Channel  (top)

The user-defined marketing entity created to group marketing activities for analytics and budgeting.

Marketing channels are defined per the client or site company and can be used to categorize marketing activities. A marketer could, for example, define a channel for his e-commerce-related marketing activities. This marketer could assign a budget to a channel, and campaigns and marketing communication that serve to increase the e-commerce business. The marketer can then run analytics filtered on this channel.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Name

The name of the channel.

false

70

false

String

true

Description

Descriptive text for this entity.

false

250

String

true

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

BelongsToCompanyName

The name of the client or site company that owns this object.

The BelongsTo company can only be set when an object is created and cannot be changed later.

false

160

String

true

Category

A category value that has been assigned to the channel.

The available values are defined by a category definition for this entity and this field.

false

250

String

true

Type

The type of channel.

Types are used to filter, group, and sort entities. The values are defined by the category Channel Type.

false

250

String

true

DivisionName

The division that uses this channel.

false

70

String

true

DivisionId

The unique ID for the division associated with each record.

false

Int32

Status

The status contains a value from the status category for an entity.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active."

false

250

String

true

ExternalId

This shows the external ID of the object that is typically used through the SDK.

The external ID of an object is a unique identifier (GUID) by which an object can be referenced in SDK calls.

false

Guid

Relations

Name

Summary

Description

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

Division

Full details for the division associated with each record.

Results

A table of marketing results that are related to a channel.

Approvals

A table of approvals that have been filed in relation to this channel.

TeamRoles

A table of team roles assumed by staff members

Campaigns

A table of campaigns that the channel is used in.

Programs

A table of programs that the channel is used in.

Jobs

A table of jobs that represent work and tasks related to this channel.

Events

A table of events that the channel is used in.

 
BudgetKPI  (top)

These are the Key Performance Indicators (KPIs) for the budget.

The Budget KPI provides a rolled-up view for key indicators of a budget (workbook). It rolls up all budget items in all the budget worksheets that belong to a budget workbook.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

CurrencyName

The name of the currency that is used for all financial numbers in this object.

The currency is a category in the system.

false

250

String

true

RevenueBudget

The revenue that has been budgeted for in the context of this budget.

false

Double

RevenueActual

The revenue that has been accounted for in the context of this budget.

false

Double

UsedRevenueBudgetPercent

The percentage of budgeted revenue that has already been used up.

false

Double

ExpenseBudget

The budget for all expenses.

false

Double

ExpenseActual

The actual expenses accounted for in the context of this budget.

false

Double

UsedExpenseBudgetPercent

The percentage of budgeted expenses that have already been used up.

false

Double

OverspentExpenseBudgetPercent

The percent of expenses that are over budget.

false

Double

ProfitBudget

The budgeted profit.

false

Double

ProfitActual

The actual profit accounted for in the context of this budget.

false

Double

UsedProfitBudgetPercent

The percentage of budgeted profit already used up.

false

Double

Relations

Name

Summary

Description

Budget

This refers to the budget that this KPI represents.

 
BudgetSheetKPI  (top)

A collection of indicators for a Budget Sheet.

The budget sheet KPI rolls up all budget items in the budget worksheet and provides a consolidated view of the budget's key indicators.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

RevenueBudget

The revenue budgeted in the context of this budget.

false

Double

RevenueActual

The revenue accounted for in the context of this budget.

false

Double

UsedRevenueBudgetPercent

The percentage of budgeted revenue already used up.

false

Double

ExpenseBudget

The budget for all expenses.

false

Double

ExpenseActual

Actual expenses accounted for in the context of this budget.

false

Double

UsedExpenseBudgetPercent

The percentage of the budgeted expenses that have already been used up.

false

Double

OverspentExpenseBudgetPercent

The percent of overspent expenses in the budget.

false

Double

ProfitBudget

The profit that has been budgeted.

false

Double

ProfitActual

The profit that has been accounted for in the context of this budget.

false

Double

UsedProfitBudgetPercent

The percent of budgeted profit already used up.

false

Double

CurrencyName

The name of the currency that is used for all financial numbers in this object.

The currency is a category in the system.

false

250

String

true

Relations

Name

Summary

Description

BudgetSheet

This refers to the budget sheet that this key performance indicator (KPI) is showing values for.

 
BusinessSegment  (top)

A table of business segments available for use by other entities

This is a multi-select field. Its possible values are defined globally for your site using the categories feature. They are independent of the belongs-to company, division, and department assignments. Business segments identify, for example lines of business, a specific set of products, services, and/or geographical locations. Each business segment typically distinguished itself from other segments by its unique collection of customers, products and marketplaces. The concept is somewhat similar to departments and divisions in that you can use them to divide an organization along logical lines for purposes of management, budgeting, reporting, and other practical concerns. Nearly all entities that accept business segment assignments also accept department and division assignments.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Name

The name of the business segment.

false

250

String

true

Description

A short description of the business segment.

false

750

String

true

Relations

Name

Summary

Description

 
ContactsInMarketingLists  (top)

A relational view representing the contacts contained in a static marketing list.

Relational views are typically not consumed directly.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

101

false

String

true

ContactId

This refers to the contact in the list.

false

Guid

MarketingListId

The ID of the marketing list.

false

Guid

MarketingListName

The name of the marketing list.

false

128

false

String

true

Relations

Name

Summary

Description

MarketingList

The related marketing list.

 
MarketingListWithContacts  (top)

This is a marketing list that contains contacts.

Relational views are typically not consumed directly.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

101

false

String

true

MarketingListId

The ID of the marketing list.

false

Guid

ContactId

The ID of the contact.

false

Guid

Relations

Name

Summary

Description

Contact

A contact who is a member in a list.

 
MarketingEmailsForMarketingLists  (top)

This is the relational view representing the marketing email messages sent to a certain marketing list.

Relational views are typically not consumed directly. This object helps find all email marketing messages that use a certain marketing list. For example, it can be used to identify email marketing messages that address a certain segment.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

101

false

String

true

MarketingListId

The ID of the marketing list.

false

Guid

MarketingEmailMessageId

The ID of the marketing email message.

false

Int32

Relations

Name

Summary

Description

MarketingEmailMessage

A marketing email message.

 
Visit  (top)

Visits are part of the recorded information for behavioral analysis.

To set up webpage visit tracking, you must define Web Site objects in Microsoft Dynamics Marketing, and the respective script must be added to the page's HTML. A respective script from the Web Site entity is used on the webpages by the marketer; the Web Site entity is used to define a scope for recording visits on webpages. A visit records the visit length and start time for a visit, the first and last webpage, and the number of pages in one visit. It can also contain referral information that shows how the contact came to the website in this current visit.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int64

StartTime

The start date and time of this visit.

false

3

DateTime

VisitLength

The length of the visit to the website.

Int32

PageCount

The number of pages visited by the prospective contact in this visit.

false

Int32

ContactId

This refers to the prospective contact who visited the website.

Guid

ContactName

The name of the prospective contact who visited the website.

false

200

String

true

WebSiteId

This refers to the website object in Microsoft Dynamics Marketing that was tracking the visit.

false

Int32

WebSiteName

The name of the website object in Microsoft Dynamics Marketing that was tracking the visit.

false

70

false

String

true

Url

The URL of the website that was visited.

false

Max

String

true

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

BelongsToCompanyName

The name of the client or site company that owns this object.

The BelongsTo company can only be set when an object is created and cannot be changed later.

false

160

String

true

CreateDate

The date that this visit was logged in Microsoft Dynamics Marketing.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

Type

The type of visit.

Types are used to filter, group, and sort entities. The values are defined by a category.

Int32

Category

A category value that has been assigned to the visit.

The available values are defined by a category definition for this entity and this field.

false

250

String

true

FirstPageUrl

The URL of the first webpage in this visit.

false

2000

String

true

LastPageUrl

The URL of the last webpage in this visit.

false

2000

String

true

ReferringUrl

The URL of the referring website, if the visit came from a different website.

false

1000

String

true

ReferringSearchPhrase

The search phrase used, if the visit came from a search engine.

false

1000

String

true

Relations

Name

Summary

Description

Contact

This refers to the prospective contact who visited the website.

WebSite

This refers to the website object in Microsoft Dynamics Marketing that was tracking the visit.

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

 
VisitedWebSite  (top)

This provides an aggregated view of all visits to one website by the same contact.

Each record here specifies a contact ID and collects cumulative statistics about how that contact interacted with a particular web site. Each page that includes the same web site tracking script (generated by Dynamics Marketing) is considered to be the same "website".

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

101

false

String

true

WebSiteId

The ID of the WebSite object.

false

Int32

WebSiteName

The name of the WebSite object.

false

70

false

String

true

TotalDuration

The total duration of visits on this website by the respective contact.

The duration of all visits by web users on the HTML pages that have been amended with the behavioral analysis script code specific to the website.

Int32

TotalPages

The total number of visited pages on this website by the respective contact.

The total number of HTML pages that have been amended with the behavioral analysis script code (specific to the website) visited by web users.

Int32

TotalVisits

The total number of visits on this website by the respective contact.

The number of visits by web users on the HTML pages that have been amended with the behavioral analysis script code specific to the website.

Int32

ContactId

This refers to the prospective contact who visited the website.

Guid

ContactName

This is the name of the prospective contact who visited the website.

false

200

String

true

Relations

Name

Summary

Description

 
CampaignWithMarketingLists  (top)

Relational view representing the marketing lists that are used in certain campaigns

Relational views are typically not consumed directly.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

101

false

String

true

CampaignId

This refers to the campaign that this marketing entity is used in.

false

Int32

MarketingListId

Unique identifier of the marketing list

false

Guid

Relations

Name

Summary

Description

Campaign

The reference of the campaign that this marketing entity is used in.

MarketingList

The Marketing List

 
CampaignWithMarketingQueries  (top)

Relational view representing the marketing queries that are used in certain campaigns

Relational views are typically not consumed directly.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

101

false

String

true

CampaignId

This refers to the campaign that this marketing entity is used in.

false

Int32

MarketingQueryId

Unique identifier of the marketing query

false

Int32

Relations

Name

Summary

Description

Campaign

The reference of the campaign that this marketing entity is used in.

MarketingQuery

The Marketing Query

 
Department  (top)

A subunit of a division in a company.

Department records enable you to set up the system to reflect the organization at your company and at your client and vendor companies. Departments provide a consolidated or roll up view of all marketing activities that are related to a specific department. You can model an organization using a hierarchy that includes (from highest to lowest) company, division, and department levels. Both divisions and departments are optional.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

DepartmentName

The name of the department.

false

70

false

String

true

IsActive

Value indicating whether this department is active

false

Boolean

Description

Descriptive text for this entity.

false

250

String

true

Code

This is a code value that has been set by the marketer to identify marketing objects.

false

50

String

true

CompanyId

This refers to the parent company.

Guid

DivisionId

The unique ID for the division associated with each record.

false

Int32

AccountId

This refers to a departmental account ID.

false

Int32

Relations

Name

Summary

Description

Division

Full details for the division associated with each record.

Account

A related financial account

Jobs

A table of jobs requested by this department.

Campaigns

A table of related campaigns.

Programs

A table of programs run by this department.

ProjectRequests

A table of project requests filed by this department.

Tasks

A table of tasks driven by by this department.

TimeSlips

A table of time slips filed for this department.

Approvals

A table of related approvals.

BudgetSheets

A table of related budget sheets.

Expenses

A table of related expenses.

Invoices

A table of invoices filed by this department.

ClientQuotes

A table of related client quotes.

PurchaseOrders

A table of purchase orders posted by this department.

Emails

A table of direct emails sent by this department.

Events

A table of events organized by this department.

TeamRoles

A table of team roles assumed by staff members in this department.

Files

A table of related files.

Company

The parent company

 
Division  (top)

A division is a section of a company that usually consists of departments.

Divisions can be used to allocate certain marketing operations.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

DivisionName

The name of the division.

false

70

false

String

true

Status

The status contains a value from the status category for an entity.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

250

String

true

Category

A category value that has been assigned to the division.

The available values are defined by a category definition for this entity and this field.

false

250

String

true

Description

Descriptive text for this entity.

false

250

String

true

CompanyId

This refers to the company that this division is part of.

Guid

Phone

A telephone number for the division.

false

30

String

true

Fax

A fax number for the division.

false

30

String

true

URL

The URL associated with the division.

false

500

String

true

Address

The street address of the division's postal address.

false

70

String

true

City

The city where the division is located.

false

50

String

true

PostalCode

The postal code of the division's postal address.

false

30

String

true

Country

The country where the division is located.

false

30

String

true

StateProvince

The state or province where the division is located.

false

50

String

true

Relations

Name

Summary

Description

Company

This refers to the company that this division is part of.

Departments

A table of departments that are part of this division.

Jobs

A table of jobs defined by this division.

Campaigns

A table of related campaigns.

Programs

A table of marketing programs run by this division.

ProjectRequests

A table of relate project requests.

TimeSlips

A table of time slips filed by this division.

Tasks

A table of tasks defined by this division.

BudgetSheets

A table of related budget sheets.

Expenses

A table of related expenses.

Invoices

A table of invoices filed by this division.

ClientQuotes

A table of related client quotes.

PurchaseOrders

A table of purchase orders filed by this division.

Emails

A table of related emails.

Results

A table of marketing results that have been collected in relation to this division.

Events

A table of events managed by this division.

TeamRoles

A table of team roles assumed by staff members in this division.

Files

A table of related files.

Brands

A table of brands owned by this division.

Regions

A table of regions covered by this division.

Channels

A table of marketing channels owned by this division.

 
Task  (top)

A task is usually a part of a job; a job can be made up of several tasks.

Tasks and jobs are used in a similar way, where tasks can be part of a job. The task is a core element of project and task management and execution.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

TaskName

The name of the task.

false

100

false

String

true

Status

This contains a value from the status category for a task.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

250

String

true

StatusComment

A comment on the status of a job on completion of a task.

false

Max

String

true

Type

The type of task.

Types are used to filter, group, and sort entities. The values are defined by a category.

false

250

String

true

Priority

The priority of the task.

false

250

String

true

Stage

A stage includes tasks to be completed in a project within a specified amount of time.

The stage is used to group tasks in a project that are related. For example, a job may include several tasks associated with copywriting.

false

250

String

true

CreateDate

The date and time when the task was created.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

DueDate

The date and time the task should be completed.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

StartDate

The start date and time of this task.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

CompletedDate

The date and time when the task was completed.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

EstimatedHours

The estimated number of work hours needed to complete this task.

false

Double

BillableHours

The number of billable hours that has actually been completed for this task.

false

Double

TotalHours

The total number of work hours used to complete this task.

false

Double

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

DepartmentId

The unique ID for the department associated with each record.

false

Int32

CampaignId

This refers to the campaign that this marketing entity is used in.

false

Int32

ProgramId

This refers to the program that this marketing entity is used in.

false

Int32

EventId

The unique ID of an event associated with this entity.

false

Int32

JobId

This refers to a related job for this entity.

false

Int32

ProductId

This refers to a related product.

false

Int32

OpportunityId

This refers to a related opportunity.

false

Int32

NextTaskId

This refers to the next task to be worked on after this task has been completed.

false

Int32

JobMilestoneId

This refers to the job milestone which marks when a specific stage of a project should be completed.

The milestone category is used to designate tasks in a project that indicates completion of a phase or stage of a project. For example, a job may include several tasks associated with copywriting; the milestone for this task stage might be the completion of the final approval task.

false

Int32

AssignedToReminderDate

The date and time when a reminder is sent to the contact to which the task has been assigned.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

AssignedByReminderDate

The date and time a reminder is sent to the contact who assigned a task to someone.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

ChangeJobStatusTo

The status which the job will change to when the task is completed.

false

250

String

true

AssignedToContactId

This refers to the contact to which the task has been assigned.

Guid

AssignedByContactId

This refers to the contact who assigns a task to a worker.

Guid

AssignedForContactId

This refers to the contact the task was created for.

Guid

DivisionId

The unique ID for the division associated with each record.

false

Int32

ComponentId

The ID of a component record that is related to this task.

false

Int32

ComponentName

The name of a component that is related to this task.

false

70

String

true

CRMId

This refers to the ID a object has in Microsoft Dynamics CRM.

The Microsoft Dynamics Marketing Connector for Microsoft Dynamics CRM synchronizes data between the two systems. For objects that have a corresponding object in Dynamics CRM, this field contains the unique ID this object has in Microsoft Dynamics Marketing.

Guid

BrandId

This shows the ID of a brand that this task is relevant for.

false

Int32

Relations

Name

Summary

Description

NextTask

This refers to the next task to be worked on after this task has been completed.

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

Division

Full details for the division associated with each record.

Department

Full details for the department associated with each record.

Campaign

The campaign that this marketing entity is used in.

Program

This refers to the program that this marketing entity is used in.

Job

The related job this task is part of.

Event

The event for which this task need to be completed

AssignedToContact

The contact the task has been assigned to.

AssignedByContact

The contact who assigned the task to someone.

AssignedForContact

The contact for whom the task was created for but assigned to someone else.

JobMilestone

The job milestone refers to when a specific task is finished.

Sessions

A table of event sessions that are relevant to this task.

Product

This refers to a product that this task is relevant for

Opportunities

A table of opportunities that are relevant to this task.

Brand

This refers to a brand that this task is relevant for.

Component

Refers to a component record related to this task.

BusinessSegmentTasks

A table of business segments that apply to the task.

 
Product  (top)

A product that is marketed through different marketing activities.

Microsoft Dynamics Marketing lets you create new products and services, and define their attributes. You can also define product line positioning categories, and track product or service rating.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Name

The name of the product.

false

250

String

true

IsActive

A value that indicates whether or not the product is active.

false

Boolean

Code

A code value that has been set by the marketer to identify marketing objects.

false

70

String

true

Status

The status contains a value from the status category for an entity.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

250

String

true

Type

The type of product.

Types are used to filter, group, and sort entities. The values are defined by a category.

false

250

String

true

SubType

A subtype for the product.

Types are used to filter, group, and sort entities. The values are defined by a category.

false

250

String

true

Description

Descriptive text for this entity.

false

Max

String

true

ReleaseDate

The date and time the product is to be released.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

DivisionId

The unique ID for the division associated with each record.

false

Int32

DepartmentId

The unique ID for the department associated with each record.

false

Int32

BrandId

Unique identifier of the relevant brand.

false

Int32

Relations

Name

Summary

Description

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

Department

Full details for the department associated with each record.

Division

Full details for the division associated with each record.

Campaigns

A table of related campaigns.

Programs

A table of programs related to the product.

BudgetSheets

A table of related budget sheets.

Expenses

A table of related expenses.

Invoices

A table of invoices related to the product.

ClientQuotes

A table of related client quotes.

PurchaseOrders

A table of Purchase Orders related to the product.

Results

A table of marketing results related to the product.

Jobs

A table of jobs related to the product.

Approvals

A table of related approvals.

ProductTasks

A table of tasks that have been created in the context of this product.

TeamRoles

A table of team roles related to the product.

Files

A table of related files.

Tasks

A table of tasks related to the product.

Brand

The relevant brand.

Components

A table of components related to this product.

 
Advertisement  (top)

Advertisements are used to advertise in different communication channels.

These are composed of files, run under a budget, and have information about the media outlet or email marketing message they are used in. Other information covers the period in which they are in service and when they expire.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Name

The name of the advertisement.

false

70

false

String

true

MediaOutletType

The type of media outlet used for this advertisement.

false

750

String

true

Code

A code value that has been set by the marketer to identify marketing objects.

false

50

String

true

Status

The status contains a value from the status category for an entity.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

250

String

true

Type

The type of advertisement.

Types are used to filter, group, and sort entities. The values are defined by a category.

false

250

String

true

Description

Descriptive text for this entity.

false

Max

String

true

Memo

Memo text added to the record. This text typically provides extra information and/or comments.

false

Max

String

true

StartDate

The start date of the advertisement.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

InServiceDate

The date and time the advertisement is in service.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

ExpirationDate

The date and time the advertisement expires.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

Phone

This is a phone with DNIS definition related to this advertisement.

A phone is defined globally in Microsoft Dynamics Marketing. It contains the DNIS identifier (Dialed Number Identification Service). This is used with telemarketing and telephone services. It is the number that the caller transmits to the receiver of a call. It's a common feature of 1-800 and 1-900 lines. If you have multiple 1-800 or 1-900 numbers that are answered by the same phone system, DNIS tells the controlling program on this system which number was dialed.

false

250

String

true

SourceCode

The SourceCode is a mechanism to tag marketing objects and connect interactions and behavioral observations.

SourceCodes are defined on a global level and can be assigned to various marketing objects like campaigns, landing pages, email marketing messages, advertisements, and more. Interactions and behavioral observations will be tagged with the respective SourceCode value. This allows you to differentiate between user responses and marketing activities that have the same SourceCode. The concept of SourceCode tagging will be implemented further in future releases of Microsoft Dynamics Marketing.

false

250

String

true

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

ParentId

This shows the site or client company that this advertisement belongs to.

Guid

MarketingEmailMessageId

This shows the marketing email message that makes use of this advertisement.

false

Int32

OfferId

This shows the ID of an offer made in this advertisement.

false

Int32

Relations

Name

Summary

Description

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

ParentCompany

The site or client company that this advertisement belongs to.

MarketingEmailMessage

This is a marketing email message that makes use of this advertisement.

Approvals

This is a table of related approvals.

Campaigns

This is a table of related campaigns.

BudgetSheets

This is a table of related budget sheets.

ClientQuotes

This is a table of related client quotes.

PurchaseOrders

This is a table of related purchase orders.

Expenses

This is a table of related expenses.

Invoices

This is a table of related invoices.

Products

This is a table of related products.

Results

This is a table of related marketing results.

Jobs

This is a table of related jobs.

Details

This is a collection of attributes that describe layout and format details for the advertisement.

Offer

This refers to an offer that is made in this advertisement.

Files

This is a table of related files.

CustomFields

The table of custom field values that have been saved for this advertisement.

 
AdvertisementDetail  (top)

A collection of measures and other attributes that describe layout and format details for the advertisement.

Not all measures and attributes apply to every advertisement.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

TrimWidth

The width the media is trimmed.

This unit of measure is captured in the field WidthHeightUnits.

Double

TrimHeight

The height for trimming the media.

The unit of measure is captured in the field for WidthHeightUnits.

Double

BleedWidth

The BleedWidth specifies the width of bleed area.

This is the area that includes crop marks and extends outside of the physical page.

Double

BleedHeight

The BleedHeight specifies the height of the bleed area.

This is the area that includes crop marks and extends outside of the physical page.

Double

WidthHeightUnits

If any width or height measures are set, this captures the unit of measure for them.

false

250

String

true

PageCount

The number of pages for the advertisements if such a measure applies.

Int32

PaperType

The paper type to be used to print the advertisement.

false

250

String

true

PaperWeight

The paper weight to be used to print the advertisement.

false

250

String

true

ColorCount

The number of colors used in the advertisement collaterals.

false

250

String

true

Weight

A weight measure for the advertisement if such applies.

Double

WeightUnit

If a weight measure has been specified, this contains the unit of measure.

false

250

String

true

Duration

A duration value for an advertisement if such applies.

false

250

String

true

DurationUnits

The respective unit of measure for the duration.

If a duration has been set, this is the respective unit of measure.

false

250

String

true

FramesPerSecond

For digital media this contains the frames shown per second.

false

50

String

true

Format

The format of the advertisement.

false

250

String

true

Relations

Name

Summary

Description

 
Approval  (top)

A record that holds details about a single approval request.

Each approval record holds details about an approval request, including the contact that requested the approval, important dates, and the current status. Each approval record also includes relations to associated records and tables that specify the items being considered for approval, the contacts responsible for reviewing and approving the request, and other associated information.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

41

false

String

true

RequestId

This is the approval request.

false

Int32

Request

The text of the request.

false

Max

String

true

RequestedByContactId

This is the contact who requested the approval.

Guid

Category

A category value that has been assigned to this marketing entity.

The available values are defined by a category definition for this entity and this field.

false

750

String

true

Type

The type of the approval.

Types are used to filter, group, and sort entities. The values are defined by the category Channel Type.

false

750

String

true

Status

The status contains a value from the status category for an entity.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

250

String

true

Priority

The priority of the approval.

false

250

String

true

StatusDate

The date on which the current status was set.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

DueDate

The date that the approval is due and will be processed.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

ReminderDate

The date that a reminder for approval will be sent.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

RequestDate

The date on which the approval was requested.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

CompletedDate

The date that the approval was processed.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

Routing

The routing information for the approval.

false

750

String

true

JobId

This is a related job for this entity.

false

Int32

CustomPageCount

The number of pages included in the approval.

Int32

DepartmentId

The unique ID for the department associated with each record.

Int32

DivisionId

The unique ID for the division associated with each record.

Int32

Relations

Name

Summary

Description

RequestedByContact

This refers to the contact who requested the approval.

ApprovalEmails

This is a table of approval messages that have been sent in the approval process.

ApprovalItems

This is a table of items in the approval.

Approvers

This is a table of approvers who are required to process this approval.

Job

A related job for this entity.

Brands

A table of brands that are relevant for this approval.

Regions

A table of regions that are relevant for this approval.

Channels

A table of channels that are relevant for this approval.

BusinessSegmentApprovals

A table of business segments assigned to the approval.

Department

Full details for the department associated with each record.

Division

Full details for the division associated with each record.

 
ApprovalEmail  (top)

A piece of communication that is part of the approval process.

Approval emails are sent to inform approvers so that the approval process can be initiated. These emails aren't email marketing messages but simple SMTP emails.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

281

false

String

true

ApprovalId

This is the relevant approval.

false

41

false

String

true

EmailId

This is the email object that has been sent to request approval.

Emails are sent to inform approvers so that the approval process can be initiated. These emails are not email marketing messages but simple SMTP emails.

false

Int32

Relations

Name

Summary

Description

Email

This refers to an email object that has been sent for an approval request.

Emails are sent to inform approvers so that the approval process can be initiated. These emails are not email marketing messages but simple SMTP emails.

 
ApprovalItem  (top)

The elements of an approval.

During the approval process, the various reviewers can add comments to provide feedback to the requester. This table holds each individual comment and relates each of them to the approval request record it applies to.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

ApprovalId

This refers to the approval ID of an item.

false

41

false

String

true

Comment

A comment made by the creator of the approval item.

false

Max

String

true

Author

The name of the author of an approval item.

false

200

String

true

Date

The date when this item was created.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

7

DateTime

ComponentId

The ID for the component record related to an approval item

false

Int32

ComponentName

The name of a component related to an approval item.

false

70

String

true

Relations

Name

Summary

Description

Component

Refers to the record for a component attached to the approval item.

 
Approver  (top)

An approver is the contact who has been tasked with signing off on an approval.

The record contains information about the start and completion date of the sign off for one contact. It also contains the status of the sign off for this contact.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

ApprovalId

This refers to the respective approval.

false

41

false

String

true

ContactId

The ID for the contact who is the approver.

Guid

Status

The status contains a value from the status category for an entity.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

250

String

true

StartDate

The start date for the approver.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

CompletedDate

The date of completion for the approval.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

Relations

Name

Summary

Description

Contact

This refers to the contact for this approver.

 
ProjectRequest  (top)

Project requests are created to request jobs.

The project-request function enables users to create requests to be placed in a queue where they can be reviewed or assigned for review prior to users creating a task, job, campaign, event or program. This two-step approach provides metrics to track requests and the performance of the team processing them. Job requests are similar, but result in the immediate creation of a job, without an intermediate step. Both project requests and job requests are template-driven - users create templates that include the questions that requesters must answer to submit a request.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Status

The status contains a value from the status category for an entity.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

250

String

true

Type

The type of request.

Types are used to filter, group, and sort entities. The values are defined by a category.

false

70

String

true

Request

The name of this request.

false

70

false

String

true

CreatedDate

The creation date for the project request.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

NeedBy

The date and time the project or job is needed by.

Date and time are stored in UTC.

3

DateTime

EstimatedCompletion

The date and time when the project or job should be completed.

Date and time are stored in UTC.

3

DateTime

DepartmentId

The unique ID for the department associated with each record.

false

Int32

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

DivisionId

The unique ID for the division associated with each record.

false

Int32

RequestedByContactId

This refers to the contact who filed this request.

Guid

CampaignId

This refers to the campaign that this marketing entity is used in.

false

Int32

ProgramId

This refers to the program that this marketing entity is used in.

false

Int32

JobId

This refers to a related job for this entity.

false

Int32

EventId

The unique ID of an event associated with this entity.

false

Int32

Relations

Name

Summary

Description

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

RequestedByContact

The contact who filed this request.

Department

Full details for the department associated with each record.

Division

Full details for the division associated with each record.

Campaign

The campaign that this marketing entity is used in.

Program

The program that this marketing entity is used in.

Expenses

A table of related expenses.

Invoices

A table of related invoices.

ClientQuotes

A table of related client quotes.

PurchaseOrders

A table of related purchase orders.

Emails

A table of related emails.

Job

A related job for this entity.

Events

A table of related events.

Estimates

A table of estimates that have been made in the context of the marketing entity.

Files

A table of related files.

BusinessSegmentProjectRequests

A table of business segments that apply to the project request.

 
Job  (top)

Jobs are a core element of project and task management and execution. A job is used to manage an amount of work, typically in the context of a marketing activity and often for one or more tasks.

Jobs allow estimation and registration of billable and non-billable hours and can be requested through Job Requests. They can be queued and related to other jobs.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Status

The status contains a value from the status category for an entity.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

250

String

true

Priority

The priority of the job.

false

250

String

true

JobName

The name of the job.

false

70

false

String

true

Code

A code value that has been set by the marketer to identify marketing objects.

false

70

String

true

Description

Descriptive text for this entity.

false

250

String

true

URL

A URL related to the job.

A URL can be used to record web content for which work is done as part of this job.

false

500

String

true

Specifications

The written specifications of the work for this task.

false

Max

String

true

Folder

A folder name for storing files that are produced as part of the job.

false

250

String

true

Quantity

A quantity value that is relevant for this job.

Double

StartDate

The start date and time of the job.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

DueDate

The date when the job is due to be completed.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

CompletedDate

The date when this job was completed.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

UpdateDate

The date and time the job was last updated.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

7

DateTime

Billable

A value indicating whether the work hours done as part of this job can be billed.

false

Boolean

ShowOnWebPortal

A flag indicating whether the job is shown to users on a portal who only have the Web Portal role.

false

Boolean

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

DivisionId

The unique ID for the division associated with each record.

false

Int32

DepartmentId

The unique ID for the department associated with each record.

false

Int32

AccountId

This refers to a related financial account.

false

Int32

ContractId

This refers to the related contract.

false

Int32

CampaignId

This refers to the campaign that this marketing entity is used in.

false

Int32

EventId

The unique ID of an event associated with this entity.

false

Int32

NextJobId

This refers to the following job to be processed after this one is complete.

Jobs can be maintained in a linked list to be processed in a certain order.

false

Int32

ReferenceJobId

This refers to a referenced job that is related to this one.

false

Int32

EstimatedHours

The estimated number of hours needed to complete this job.

false

Double

BillableHours

The number of billable hours that have been worked on this job.

false

Double

NonBillableHours

The number of hours that cannot be billed but have actually been worked for this job.

false

Double

BillableVsEstimated

The amount of billable hours minus the total estimated number of hours needed to complete this job.

BilledVsEstimated = BillableHours - EstimatedHours.

false

Double

TotalVsEstimated

The difference between billable and non-billable work actually delivered for this job, and the original estimation.

TotalVsEstimated = BillableHours + NonBillableHours - EstimatedHours

false

Double

Type

Type indicates whether a job record is a template or a job.

The possible type values are maintained by a category.

false

250

String

true

ExternalId

This shows the external ID of the object that is typically used through the SDK.

The external ID of an object is a unique identifier (GUID) by which an object can be referenced in SDK calls.

false

Guid

Relations

Name

Summary

Description

JobKPIs

A table of Job KPIs, one for each currency if the multi currency feature is used.

ProjectRequests

A table of project requests relevant to this job.

NextJob

The job that should be taken up after completion of this job.

ReferenceJob

Another job that is relevant when working on this job.

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

Division

Full details for the division associated with each record.

Department

Full details for the department associated with each record.

Account

A related financial account.

Campaign

This refers to a related campaign.

Programs

A table of programs relevant to this job.

Advertisements

The table of advertisements related to this job.

Channels

A table of channels relevant to this job.

BudgetSheets

A table of related budget sheets.

ClientQuotes

A table of related client quotes.

Contacts

A table of contacts that are relevant to this job.

This is often a table of individuals who deliver work for this job.

Expenses

A table of related expenses.

Invoices

A table of invoices relevant to this job.

PurchaseOrders

A table of purchase orders relevant to this job.

Leads

A table of leads relevant to this job.

MarketingLists

A table of marketing lists relevant to this job.

MarketingQueries

A table of marketing queries relevant to this job.

MarketingEmailMessages

A table of marketing email messages relevant to this job.

TimeSlips

A table of time slips relevant to this job.

Event

The marketing event that this job was created for.

Contract

A contract that has been created in relation to the work to be done for this job.

Estimates

A table of estimates that have been made in the context of the marketing entity.

Products

A table of related products.

Tasks

A table of tasks relevant to this job.

TeamRoles

A table of team roles relevant to this job.

This typically lists the different contacts involved, with their roles in this job.

JobRequests

A table of job requests relevant to this job.

Files

A table of related files.

Results

A table of marketing results relevant to this job.

Brands

The table of brands relevant for this job

Regions

The regions that are relevant to this job.

CustomFields

Table of custom field values that have been saved for this job.

MarketSegments

The market segments that are relevant in this job.

Components

A table of components related to this job.

BusinessSegmentJobs

A table of business segments that apply to the job.

 
JobMilestone  (top)

A step in the completion of a project or job.

Each milestone record establishes its position in the milestone hierarchy, including its status as a major or minor milestone and its group membership.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

IsActive

A value indicating whether a milestone is active.

false

Boolean

Major

A value indicating whether this is a major milestone.

false

250

String

true

Group

this refers to a grouping in milestones

false

250

false

String

true

Name

The name of the milestone.

false

250

false

String

true

Description

Descriptive text for this entity.

false

Max

String

true

UpdateDate

The date and time when the job milestone was last updated.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

7

DateTime

Relations

Name

Summary

Description

 
JobKPI  (top)

A set of financial KPI (key performance indicator) values for a job in a specific currency.

The currency is specified by a JobCurrency object.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

41

false

String

true

JobId

The ID for the job of this KPI (key performance indicator).

false

Int32

CurrencyName

The name of the currency that is used for all financial numbers in this object.

The currency is a category in the system.

false

250

String

true

ExpenseTotal

The total sum of expenses for this job.

false

Double

PurchaseOrderTotal

The total sum of purchase orders for this job in the respective currency.

false

Double

PurchaseOrderVariance

The difference between the total amount of purchase orders and the total amount of expenses.

PurchaseOrderVariance = PurchaseOrderTotal - ExpenseTotal. This amount is the partial amount of purchase orders that is not reflected by the amount of expenses.

false

Double

ClientQuoteTotal

The total sum in client quotes that have been prepared as part of this job.

This financial number is for one currency, specified by the JobCurrency relation.

false

Double

InvoiceTotal

The total sum of invoices related to this job.

false

Double

DirectLaborTotal

The total cost of labor for this job.

false

Double

InvoiceVariance

This is the difference between the total invoice amount and the total of client quotes.

InvoiceVariance = InvoiceTotal - ClientQuoteTotal This amount is the partial amount from invoices that are not covered by amounts from client quotes.

false

Double

PaymentTotal

The total sum of payments made for this job.

false

Double

BalanceDue

The balance due is the difference between expenses and payments.

BalanceDue = ExpenseTotal - PaymentTotal. This amount is the partial amount of expenses that is not covered by payments.

false

Double

Profit

The profit made with this job.

false

Double

ProfitPercentage

The profit made with this job in percentage.

false

Double

Relations

Name

Summary

Description

Job

The related job.

 
TimeSlip  (top)

A time slip is used to report the hours a contact works on a task or job.

It contains cost and price for the work and puts the work in relation to relevant marketing activities.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Status

This contains a value from the status category for a time slip.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

750

String

true

Description

Descriptive text for this entity.

false

250

String

true

Billable

A value indicating the billable work hours on a time slip.

Boolean

Invoiced

The value indicating that the work in this time slip is covered by an invoice.

Boolean

InvoiceNumber

The number of the invoice if the work in this time slip is covered by an invoice.

false

70

String

true

ServiceDate

The date and time the work in relation to the item or service was delivered.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

CreatedDate

The creation date for the time slip.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

ContactId

This refers to the ID of a contact.

Guid

CreatedByContactId

This refers to the staff contact who created this object.

Guid

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

ServiceId

This refers to the item or service for which the work in this time slip was delivered.

false

Int32

DivisionId

The unique ID for the division associated with each record.

false

Int32

DepartmentId

The unique ID for the department associated with each record.

false

Int32

CampaignId

This refers to the campaign that this marketing entity is used in.

false

Int32

ProgramId

This refers to the program that the time slip is used for.

false

Int32

EventId

The unique ID of an event associated with this entity.

false

Int32

JobId

This refers to a related job for this entity.

false

Int32

ProductId

This refers to a related product for this time slip.

false

Int32

TaskId

The ID of a task related to the time slip.

false

Int32

ActualHours

The number of hours that have actually been worked within the scope of this time slip.

false

Double

BillableHours

The number of billable hours on a time slip.

false

Double

UnbillableHours

The number of hours that have actually been worked but cannot be billed on the time slip.

false

Double

Currency

The currency used for all financial numbers on a time slip.

false

250

String

true

HourlyPrice

The asked price of work per hour.

false

Double

TotalHourlyPrice

The hourly price tag for the work in this time slip.

false

Double

HourlyCost

A record of the cost of work per hour.

false

Double

TotalHourlyCost

The hourly cost for the work in this time slip.

false

Double

Relations

Name

Summary

Description

Contact

A related contact for this entity.

CreatedByContact

The contact who created this time slip.

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

Division

Full details for the division associated with each record.

Department

Full details for the department associated with each record.

Campaign

A related campaign for the time slip.

Program

The program that this time slip is used for.

Job

A related job for this time slip.

Product

A related product for this time slip.

Task

A related task for this time slip.

ItemService

A related item or service in relation to which the work in this time slip has been delivered.

Event

A related event for which the time slip has been filed

 
ItemService  (top)

This describes an item or service that is sold to customers as part of marketing activities.

Use items to track things that are bought, sold, or used. Items and services appear on financial transactions and are used to track the items and services bought, sold, or used. Items are things like brochures, mugs, etc. There are two types of items: - Standard Items: Standard items can be used to track the things that you buy, sell, and use. - Inventory Items: Sites that use the Advanced Inventory function of Microsoft Dynamics Marketing can create and use inventory items. Microsoft Dynamics Marketing provides advanced inventory management functions for inventory items.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Active

A value indicating whether the item or service is active and can be used for transactions.

false

Boolean

Name

The name of the item or service.

false

70

false

String

true

Group

The group name that this item or service is part of.

Use groups to declare a relationship of several item or services.

false

750

String

true

Type

The type of item or service.

The possible type values are maintained by a category.

false

250

String

true

Description

Descriptive text for this entity.

false

Max

String

true

Taxable

A value indicating whether transactions in relation to this item or service are taxable.

Boolean

RevenueAccountId

This refers to a related revenue account.

false

Int32

ExpenseAccountId

This refers to a related expense account.

false

Int32

CreatedByContactId

This refers to the contact who has created this item or service in the system.

Guid

Relations

Name

Summary

Description

CreatedBy

The contact who has created this item or service in the system.

PriceRates

A table of price rates for this item or service.

RevenueAccount

This is a related revenue account.

ExpenseAccount

This is a related expense account.

TimeSlips

A table of related time slips

 
PriceRate  (top)

The price or the rate for an item or service.

Item or service records can include a schedule of prices and rates associated with that item or service. Each record here is a line item for a specific item or service record, and includes the ID of the records it applies to and other data and metadata.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

ItemServiceId

The ID of the item or service.

false

Int32

ContactId

The ID of the contact.

Guid

CurrencyName

The name of the currency that is used for all financial numbers in this object.

The currency is a category in the system.

false

250

String

true

Price

The price or rate for the item or service.

false

Double

Cost

The cost for the item or service.

false

Double

UpdateDate

The date and time this entity was last updated.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

7

DateTime

Relations

Name

Summary

Description

Contact

A related contact for this price or rate.

ItemService

The related item or service.

 
Event  (top)

The event is the core entity for event management and event marketing.

An event is composed of sessions for which tickets (registration set ups) can be defined. For an event, registrations and records of attendance can be recorded. An event can be configured to create lead interactions and leads according to the lead creation granularity. An event takes place at a venue and uses its facilities. An event can have an exhibition. Project, task, and job management can be used with events. Resources and staff can be booked for an event, including management of billable hours. Event marketing is subject to budgeting, purchase, expense, and invoice management.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Code

A code value that has been set by the marketer to identify marketing objects

false

50

String

true

Name

The name of the event.

false

250

false

String

true

StartDate

The end date and time of the event.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC). Please note that the time zone the event takes place in is stored in the field "TimeZone".

false

3

DateTime

EndDate

The end date and time of the event.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC). Please note that the time zone in which the event takes place is stored in the field "TimeZone".

false

3

DateTime

ExhibitStartDate

The start date and time of the exhibition, if that is part of the event.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC). Please note that the time zone the event takes place in is stored in the field "TimeZone".

3

DateTime

ExhibitEndDate

The end date and time of the exhibition, if that is part of the event.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC). Please note that the time zone the event takes place in is stored in the field "TimeZone".

3

DateTime

TimeZone

The time zone the event takes place in.

Date and time values are stored in UTC, but it is important to know which actual time zone certain marketing activities take place in.

false

250

String

true

EstimatedAttendance

The estimated number of records of attendance for this event.

Int32

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

DivisionId

The unique ID for the division associated with each record.

false

Int32

DepartmentId

The unique ID for the department associated with each record.

false

Int32

CampaignId

This refers to the campaign that this event is a part of.

false

Int32

ProgramId

This refers to the program that provides the marketing context for this event.

false

Int32

EstimatedHours

The estimated number of work hours for this event.

false

Double

BillableHours

The number of work hours that are billable for this event.

false

Double

NonBillableHours

The number of work hours in the event that are not billable.

false

Double

BillableVsEstimated

The amount of billable hours minus the total estimated number of work hours for this event.

BilledVsEstimated = BillableHours - EstimatedHours.

false

Double

TotalVsEstimated

This compares the total number of work hours in this event versus the estimated work hours.

false

Double

Status

The status contains a value from the status category for an entity.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

250

String

true

Description

Descriptive text for this entity.

false

Max

String

true

VenueId

This refers to the venue where this event is taking place.

Please note: The build in venue "Lync Webinar" is not represented by a venue object but just as the VenueId -1. If an OData query expands on the Venue field, it is advised to first filter out events with the VenueId = -1.

false

Int32

CreatedByContactId

This refers to the staff contact who created this object.

Guid

Folder

The name of the folder under which the record is displayed in the Dynamics Marketing navigation interface.

Folders in Dynamics Marketing are similar to folders in Microsoft Windows. You can use them to organize or categorize your records to make them easier to find and browse.

false

250

String

true

ExternalId

This shows the external ID of the object that is typically used through the SDK.

The external ID of an object is a unique identifier (GUID) by which an object can be referenced in SDK calls.

Guid

Relations

Name

Summary

Description

CreatedBy

This refers to the staff contact who created this object.

EventKPIs

A table of key performance indicators (KPIs) that have been calculated for this event.

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

Campaign

The campaign that provides the marketing context for this event.

Program

The program that provides the marketing context for this event.

Department

Full details for the department associated with each record.

Division

Full details for the division associated with each record.

BudgetSheets

A table of related budget sheets.

Channels

A table of marketing channels that are relevant to this event.

ClientQuotes

A table of related client quotes.

PurchaseOrders

A table of purchase orders that have been filled in relation to this event.

Invoices

A table of invoices that have been filed in relation to this event.

Expenses

A table of related expenses.

Jobs

A table of jobs that are related to this event.

Leads

A table of leads that have been created for this event.

MarketingEmailMessages

A table of email marketing messages that are used in relation to event marketing for this event.

ProjectRequests

A table of projects requests that have been filed in relation to this event.

Venue

A venue where this event is taking place.

Please note: The build in venue "Lync Webinar" is not represented by a venue object but just as the VenueId -1. If an OData query expands on the Venue field, it is advised to first filter out events with the VenueId = -1.

Sessions

A table of sessions that take place as part of this event.

Attendances

A table of records of attendances that have been recorded for this event.

RegistrationSetups

A table of registration setups that have be defined for event sessions or entire events.

A registration setup can be compared to the definition of a ticket for a session or an entire event. It can have a price and a certain availability. A registration setup is also the place to select the access mode, such as a webinar as opposed to in-person participation.

Registrations

A table of registrations that have been recorded for this event.

Results

A table of marketing results that have been recorded for this event.

TimeSlips

A table of time slips that have been filed in relation to this event.

TeamRoles

A table of team roles assumed by staff members

Approvals

A table of related approvals.

Brands

This is a table of brands relevant in this marketing event

MarketSegments

Table of Market Segments that are targeted by this marketing event

EquipmentBookings

A table of equipment bookings made for individual sessions during an event.

Equipment bookings are related to equipment requests, and exist as line items for a given request. An equipment request applies to a full event, while an equipment booking reserves a piece of equipment for an individual session held during that event. You might have several equipment bookings associated with a single equipment request.

StaffSpeakers

A table of staff/speaker activities associated with the event.

CustomFields

A table of custom field names and values that apply to each event record

BusinessSegmentEvents

A table of business segments that apply to the event.

 
EventCustomFields  (top)

Provides user defined field names and values for events

Dynamics Marketing provides a fixed collection of user defined fields of various types, but none of these are enabled by default. Only those fields that have been enabled on your site are provided by this entity.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Relations

Name

Summary

Description

TextValues

A table that lists all user defined fields and values of type "text" for a given record.

FloatValues

A table that lists all user defined fields and values of type "float" for a given record.

CategoryValues

A table that lists all user defined fields and values of type "category" for a given record.

DateTimeValues

A table that lists all user defined fields and values of type "date/time" for a given record.

 
EventKPI  (top)

The KPI (key performance indicator) object delivers a set of aggregated measurements for an event.

Each record here provides details for a specific event KPI, including financial details and a relation to the event record that the KPI applies to.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

41

false

String

true

CurrencyName

Name of the currency that applies to all financial numbers in this KPI

false

250

String

true

EventId

The unique ID of an event associated with this entity.

false

Int32

ExpenseTotal

The total amount of all expenses in this KPI's currency, in the context of the event.

false

Double

PurchaseOrderTotal

The total amount from purchase orders related to the event.

false

Double

PurchaseOrderVariance

The difference of the total amount of purchase orders and the total amount of expenses.

PurchaseOrderVariance = PurchaseOrderTotal - ExpenseTotal This amount is the partial amount of purchase orders that is not reflected by the amount of expenses.

false

Double

ClientQuoteTotal

The total amount from the client quote related to the event.

false

Double

InvoiceTotal

The total amount from invoices related to the event.

false

Double

DirectLaborTotal

The total amount of direct labor related to the event.

false

Double

InvoiceVariance

The difference between the total invoice amount and the total client quotes.

InvoiceVariance = InvoiceTotal - ClientQuoteTotal This amount is the partial amount from invoices that are not covered by amounts from client quotes.

false

Double

PaymentTotal

The total amount of payments related to the event.

false

Double

BalanceDue

The balance due is the difference between expenses and payments.

BalanceDue = ExpenseTotal - PaymentTotal This amount is the partial amount of expenses that is not covered by payments.

false

Double

Profit

The profit made from the event.

Profit = InvoiceTotal - DirectLaborTotal - ExpenseTotal The profit is calculated from the total amount of invoices deducted by the total amount of labor and the total amount of expenses.

false

Double

ProfitPercentage

The profit made from the event, by percent.

false

Double

Relations

Name

Summary

Description

Event

The event which this KPI relates to

 
Estimate  (top)

An estimate enables users to prepare detailed price, cost, and time estimates.

Estimates can be 'stand-alone' or linked to a project, job, campaign, event, or program. Microsoft Dynamics Marketing also enables users to compare estimated costs, revenue, and time against actuals for estimates linked to projects.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Name

The name of this object.

false

70

String

true

Memo

Memo text added to the record. This text typically provides extra information and/or comments.

false

Max

String

true

Status

The status contains a value from the status category for an entity.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

250

String

true

Default

An indicator whether this is the default budget estimate.

Boolean

ProjectType

The type of project which characterizes the estimate.

The out-of-box types are: Campaign, component, event, job, and program.

false

750

String

true

StartDate

The start date and time for the estimate.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

DueEndDate

The due or end date and time for the project related to this estimate.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

ExpirationDate

The date and time at which the estimate expires and may need to be renewed.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

PreparedByContactId

This refers to the contact who has prepared the estimate.

Guid

PreparedForContactId

This refers to the contact for whom the estimate has been prepared.

Guid

CampaignId

This refers to the campaign that this marketing entity is used in.

false

Int32

ProgramId

This refers to the marketing program that this estimate is used with.

This field is used if the project type "Program" has been chosen.

false

Int32

JobId

This refers to a related job for this entity.

This field is used if the project type "Job" has been chosen.

false

Int32

ComponentId

The ID of the component record that this estimate applies to.

false

Int32

EventId

The unique ID of an event associated with this entity.

false

Int32

ComponentName

The name of the component that this estimate applies to.

false

70

String

true

ProjectRequestId

This refers to the related project request.

false

Int32

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

Relations

Name

Summary

Description

EstimateItems

A table of items that the estimate consists of.

ProjectRequest

A related project request.

This field is used if the project type "Project" has been chosen.

Job

A related job for this entity.

This field is used if the project type "Job" has been chosen.

Program

The program that this marketing entity is used in.

This field is used if the project type "Program" has been chosen.

Campaign

The campaign in which this estimate was made.

This field is used if the project type "Campaign" has been chosen.

PreparedBy

The contact who prepared the estimate.

PreparedFor

The contact for whom the estimate has been prepared.

Event

An event that this estimate is used for.

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

 
EstimateItem  (top)

Individual line items that belong to estimates

Each record here represents a single line item, including information about estimated costs, revenues, quantities and the ID for the full estimate record the line belongs to. Each record relates to records for the contact that created the item, the vendor that provides it, and the actual item or service to be delivered.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

EstimateId

This refers to the parent estimate.

false

Int32

Date

The date when this item was created.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

Description

Descriptive text for this entity.

false

Max

String

true

CreatedByContactId

This refers to the staff contact who created this object.

Guid

VendorContactId

This refers to a related vendor contact for this estimate.

Guid

CurrencyName

The name of the currency that is used for all financial numbers in this object.

The currency is a category in the system.

false

250

String

true

ItemServiceId

This refers to the related item or service.

Int32

EstimatedQuantityOrTime

The estimated time the service took or the estimated quantity of the item.

false

Double

EstimatedUnitCost

The unit cost is the amount paid for the item or service, not the price charged for it.

false

Double

EstimatedUnitPrice

The unit price is the amount clients paid for the item or service, not the cost paid to buy the item.

Double

EstimatedTotalCost

The calculated estimation for the total cost.

The Estimated Total Cost = (Estimated Unit Cost - Estimated Cost Discount) x Estimated Quantity or Time.

false

Double

EstimatedTotalRevenue

The estimation for the total revenue.

Double

EstimatedPriceDiscountPercent

The estimated discount percentage to be given on an item or service based on the item price.

Double

EstimatedCostDiscountPercent

The estimated discount percentage to be given on an item or service based on the item cost.

Double

Relations

Name

Summary

Description

VendorContact

A related vendor contact for this estimate.

ItemService

The related item or service to which the estimate item relates.

CreatedBy

This refers to the staff contact who created this object.

 
Contract  (top)

A document that describes the agreement between a contract manager and a contact for delivering specific work.

Contract management functions enable you to track contracts systematically. Each record provides details about important dates (including the start, end, and renewal dates) and includes relations to important contacts, jobs, and files (such as the contract itself) associated with each contract.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Active

An indicator of whether the contract is active.

false

Boolean

Code

This is a code value that has been set by the marketer to identify marketing objects.

false

70

String

true

Name

The name of the contract.

false

250

false

String

true

Type

The type of contract.

Types are used to filter, group, and sort entities. The values are defined by a category.

false

250

String

true

Category

A category value that has been assigned to the contract.

The available values are defined by a category definition for this entity and this field.

false

250

String

true

StartDate

The start date and time of the work period covered by the contract.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

EndDate

The end date and time of the work period covered by the contract.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

RenewalDate

The renewal date and time for this contract.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

Quantity

This is a quantity measure describing the delivery according to this contract.

Double

BelongsToCompanyId

The unique ID of the client or site company that owns this object.

The belongs-to company can only be set when an object is created and can't be changed later.

Guid

ContractManagerId

This refers to the contact who manages this contract, typically a staff contact.

Guid

ContactId

This refers to a related contact, typically the one working under this contract.

Guid

Relations

Name

Summary

Description

Jobs

A table of related jobs for this contract.

Contact

The related contact is typically the one working under this contract.

BelongsToCompany

The client or site company that owns this object.

The belongs-to company can only be set when an object is created and cannot be changed later.

ContractManager

A related contact who manages this contract, typically a staff contact.

Files

A table of related files.

 
Venue  (top)

A venue is a location capable of hosting an event.

Located at a certain address, a venue has the capacity for a certain number of event attendees, and often has multiple facilities.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

VenueName

The name of the venue

false

250

false

String

true

Active

A flag indicating whether the venue is active and can be used for event planning.

false

Boolean

Description

Descriptive text for this entity.

false

Max

String

true

Type

The type of venue.

Types are used to filter, group, and sort entities. The values are defined by a category.

false

250

String

true

Capacity

The number of guests a venue can host.

false

Int32

Address

The street address of the venue.

false

250

String

true

City

The city of the venue's postal address.

false

50

String

true

StateProvince

The state or province where the venue is.

false

250

String

true

PostalCode

The postal code or zip code of the venue's postal address.

false

15

String

true

Country

The country of the venue's address.

false

250

String

true

URL

The web address of the venue.

This web address may be given to event attendees for more information the venue before an event.

false

250

String

true

DepartmentId

The unique ID for the department associated with each record.

Int32

DivisionId

The unique ID for the division associated with each record.

Int32

Relations

Name

Summary

Description

Facilities

A list of facilities at this venue.

Events

A list of events taking place at this venue.

Sessions

A list of sessions held for an event at this venue.

Department

Full details for the department associated with each record.

Division

Full details for the division associated with each record.

BusinessSegmentVenues

A table of business segments that apply to the venue.

 
Facility  (top)

A facility is a part of a venue and typically represents a place where sessions takes place.

Examples of facilities are session rooms, keynote halls, rooms for presenter preparation, or exhibition halls.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

FacilityName

The name of the facility.

false

250

false

String

true

Active

A value indicating if this facility is active and can be used for event resource planning.

false

Boolean

Description

Descriptive text for this entity.

false

Max

String

true

Type

The type of facility.

The possible type value are maintained by a category FacilityType.

false

250

String

true

Capacity

This is the size of audience the facility is capable of holding.

Int32

VenueId

This refers to the ID of the venue that contains this facility.

false

Int32

DepartmentId

The unique ID for the department associated with each record.

Int32

DivisionId

The unique ID for the division associated with each record.

Int32

Relations

Name

Summary

Description

Venue

The venue that contains this facility.

Sessions

A table of sessions that take place at this facility.

Department

Full details for the department associated with each record.

Division

Full details for the division associated with each record.

BusinessSegmentFacilities

A table of business segments that apply to the facility.

 
RegistrationSetup  (top)

Registration setups are used with events and sessions to define what can be compared to a ticket.

An event registration setup can be compared to the definition of a ticket for an event and / or sessions in an event. Tickets have a price and a maximum number of availability; multiple prices for tickets to a session may also be defined.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Name

The name for the ticket.

false

250

false

String

true

Active

A value indicating whether the ticket is active and can be used for registrations.

false

Boolean

WaitList

A value indicating whether a wait list is provided if this ticket is sold out.

false

Boolean

AttendeeNamesRequired

A value indicating whether a name is required in order to register and attend.

Boolean

Description

Descriptive text for this entity.

false

Max

String

true

Credits

Credits that are being given to a registrant upon registering on this ticket.

Double

Capacity

The maximum number of participants that can be registered through this ticket definition.

Int32

Actual

The actual number of participants currently registered through this ticket definition.

false

Double

ItemStartDate

The date and time when the registration items starts.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

ItemEndDate

The date and time when the registration item ends.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

3

DateTime

RegistrationStartDate

The date and time when the registration starts.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

RegistrationEndDate

The date and time when the registration ends.

Date and time are stored as a DateTimeOffset value, which indicates the date, time and time zone (offset from UTC).

false

3

DateTime

Price

The price for the ticket.

Double

Taxable

A value indicating whether transactions in relation to this item or service are taxable.

Boolean

AccountId

This refers to a related financial account.

false

Int32

EventId

The unique ID of an event associated with this entity.

false

Int32

SessionId

This refers to a session if the registration setup has been prepared for a specific session.

false

Int32

ExternalId

This shows the external ID of the object that is typically used through the SDK.

The external ID of an object is a unique identifier (GUID) by which an object can be referenced in SDK calls.

Guid

DivisionId

The unique ID for the division associated with each record.

Int32

DepartmentId

The unique ID for the department associated with each record.

Int32

Relations

Name

Summary

Description

Languages

A table of language-specific strings for the registration setup.

RegistrationItems

A table of registration items from registrations for this ticket.

When registration for an event is made, the registrant chooses one or more tickets (registration setups) and for each one, a registration item is created.

Account

A related financial account.

Event

An event that this registration setup has been prepared for.

Session

This denotes if the registration setup has been prepared for a specific session.

Division

Full details for the division associated with each record.

Department

Full details for the department associated with each record.

BusinessSegmentEventItems

A table of business segments that apply to the registration setup.

 
RegistrationSetupLanguage  (top)

Language-specific elements for an event registration setup.

Registration setups can provide text in multiple languages. This table includes a record for each registration setup in a single language.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Active

A value indicating whether the ticket language is active.

false

Boolean

Name

The name of the language element.

false

250

false

String

true

Description

Descriptive text for this entity.

false

Max

String

true

RegistrationSetupId

The related ticket ID.

false

Int32

Language

The language for this element.

false

70

false

String

true

Relations

Name

Summary

Description

RegistrationSetup

The related ticket.

 
Registration  (top)

The signing up for event session(s) by one or more contacts and their respective event registration setups (tickets).

Recording event registrations for events and event sessions is used to manage and analyze events, and influence lead management and scoring processes. If the respective event has been configured to create lead interactions, then for each registration, a respective lead interaction of the type "Registration" is created. This allows respective leads scoring on event participation.

Fields

Name

Summary

Description

Fixed

Max

Nullable

Precision

Type

Unicode

Id

The unique identifier of this object.

The system-populated ID of the object that's contained in the OData table to create relations in an external query system.

false

Int32

Status

The status contains a value from the status category for an entity.

The possible values for status can be customized in the respective status category for an entity. Each status category has different values. One typical value is "Active".

false

250

String

true

RegistrantId

This refers to the contact this registration is for.

Guid

RegisteredByContactId

This refers to the contact who has issued the registration.

Guid

EventId

The unique ID of an event associated with this entity.

Int32

Memo

Memo text added to the record. This text typically provides extra information and/or comments.

false

Max

String