Getting started with IQA queries: Business Objects

🚧

Warning

Poorly written queries can cause performance issues in iMIS. Before starting to work with queries in the Intelligent Query Architect, review the Best practices for writing IQA queries.

IQA queries are built using business objects. Before you can begin confidently building IQA queries, you need to understand what a business object is, how business objects are used, and how business objects work. See Understanding business objects for a comprehensive review of iMIS business objects.

After you understand the basic elements of business objects, you can begin building IQA queries. iMIS provides a class of easy-to-use business objects that contain comprehensive information about your contacts, products, events, fundraisers, and much more. You can use these business objects to query specific data and report on information without creating multiple, complex joins.

To see what properties are associated with a business object, we recommend creating a new query, select the business object as the query source, then select the filters tab to view the properties.

📘

Note

To create consistency with our new naming convention, we have renamed some of the properties in our new business objects. In order to join the new business objects, the join relation might have different names on each business object.

Comparing the contact business objects

The following table goes over the differences between the contact-related business objects.

Business ObjectDetails
PartyBasicData
  • Recommended for best query performance
  • Provides rows for individuals and organizations with more properties that are needed for basic queries: Username, Primary organization, Primary club, Institute type
  • Does not include “Is member,” mobile phone, primary email, or any address information
PartyData
  • Like PartyBasicData, but includes “Is member” and mobile phone
  • Will be slower than PartyBasicData, so only use if you need “Is Member” or mobile phone
PartyWithDefaultAddressData
  • Like PartyData, but includes additional properties: Default address and email
  • May be slower than PartyBasicData, so only use if you need the additional properties
Contact
  • Provides rows for individuals and organizations
  • Limited properties available
Individual
  • Provides rows for individuals only
  • Additional contact details: Primary organization and Primary Club
Institute
  • Provides rows for organizations only
  • Additional contact details: Institute type, including company, chapter, and club
PartyWithDefaultAddressData

The PartyWithDefaultAddressData business object provides basic address information for a specific party (person or organization), including their default address. The preferred mailing address is typically used as the default address.

PartyWithDefaultAddressData properties

Properties can apply to people (P), organizations (O), or both.

* When using this business object as a source in the Intelligent Query Architect, this property is a default display column.

PropertyDescriptionApplies ToExample Data
Birth DateThe person's date of birth.P1/21/1971
DesignationThe person's designation (for example, PhD, MD, CPA).PMBA
First NameThe person's first name.PChristopher
*Full NameThe person's or organization's full name. People's names are formatted using the formula assigned in setup - typically prefix, first, middle and last name, and designation.P and OMr. Christopher T. Baker, Jr., MBA
GenderThe person's gender.PMale
IDThe person's or organization's alphanumeric ID.P and O10039
Informal NameThe informal name, or nickname, for this person.PChris
Is MemberReturns a value of True if the contact is in an Is Member group. Members with expired memberships will have a value of False for the Is Member property. P and OTrue
Is OrganizationIndicates whether this party is an organization or a person.P and OFalse
Last NameThe person's last name.PBaker
Login Is DisabledIndicates whether this person's login has been disabled.PFalse
Middle NameThe person's middle name or initial.PT.
Party IdThe person's or organization's unique identifier.P and O28f6a0f8-2fd3-4049-962a-3cb068640bf0
PrefixThe person's prefix (for example, Mr., Ms., Dr.).PMr.
*Primary Organization NameThe name of the primary organization associated with this party.POpus, Inc.
Primary Organization Party IdThe unique identifier of the primary organization associated with this person.P64371f11-b9cf-4b37-a6ff-b0a7056089a8
Sort NameThe name listed in an order typically used for sorting. For people, this is their name listed in LAST, FIRST order. For organizations, it is simply their full name in all caps.P and OBAKER, CHRIS
StatusThe person's or organization's status in the system (for example, Active, Delete). Note: This does not reflect the status of a party's membership, and is used primarily to denote contacts that are to be removed/inactivated permanently.P and OActive
SuffixThe person's suffix (for example, Jr., Sr.). PJr.
Tax ID NumberThe person's or organization's ID number used for tax purposes.P and O123456789
*TitleThe person's title.PPresident
UsernameThe person's username, if assigned.PCBAKER
Address Line 1The first address line of the physical address.P and OStonelake Building 1
Address Line 2The second address line of the physical address.P and O4030 W Braker Ln
Address Line 3The third address line of the physical address.P and OSuite 175
Address PurposeA description of this address’s use, such as Home, Work, or PO Box. This description is useful in discriminating among multiple addresses for the same person or organization.P and OWork
CityThe city portion of the physical address.P and OAustin
Country CodeThe short code indicating the country of the physical address.P and OUS
Country NameThe longer textual description of the country.P and OUnited States
CountyThe county portion of the physical address.P and OTravis
EmailThe email address associated with this address.P and O[email protected]
FaxThe facsimile telephone number associated with this address.P and O(555) 555-5555
*Formatted AddressThe full formatted address, using the Address Format defined for the country.P and OStonelake Building 1 4030 W Braker Ln Suite 175 Austin, TX 78759 United States
PhoneThe standard telephone number associated with this address.P and O(555) 555-5555
Postal CodeA series of characters used to identify an area within a country which contains the physical address.P and O78759
State Province CodeThe short code indicating the state or province of the physical address.P and OTX
State Province NameThe longer textual description of the state or province of the physical address.P and OTexas
PartyData

The PartyData business object provides basic information about a person or organization.

Business ObjectRelation
FullAddressDataPartyData.PartyId = FullAddressData.PartyId
GroupMemberDataPartyData.PartyId = GroupMemberData.PartyId
EventRegistrationDataPartyData.PartyId = EventRegistrationData.RegistrantPartyId
EventFunctionRegistrationDataPartyData.PartyId = EventFunctionRegistrationData.RegistrantPartyId
EventRegistrationFinancialDataPartyData.PartyId = EventRegistrationFinancialData.PartyId
ItemSaleData

PartyData.PartyId =ItemSaleData.BillToPartyI

OR

PartyData.PartyId = ItemSaleData.SoldToPartyI

OR

PartyData.PartyId = ItemSaleData.ShipToPartyId

InvoiceData

PartyData.PartyId = InvoiceData.BillToPartyId

OR

PartyData.PartyId = InvoiceData.SoldToPartyI

OR

PartyData.PartyId = InvoiceData.ShipToPartyId

InvoiceLineDataPartyData.PartyId = InvoiceLineData.ShipToPartyId
OrderData

PartyData.PartyIdOrder = Data.BillToPartyId

OR

PartyData.PartyId = OrderData.SoldToPartyId

OrderLineDataPartyData.PartyId = OrderLineData.SoldToPartyId
UserDataPartyData.PartyId = UserData.PartyId

PartyData properties

Properties can apply to people (P), organizations (O), or both.

* When using this business object as a source in the Intelligent Query Architect, this property is a default display column.

PropertyDescriptionApplies ToExample Data
Birth DateThe person's date of birth.P1/21/1971
DesignationThe person's designation (for example, PhD, MD, CPA).PMBA
First NameThe person's first name.PChristopher
*Full NameThe person's or organization's full name. People's names are formatted using the formula assigned in setup - typically prefix, first, middle and last name, and designation.P and OMr. Christopher T. Baker, Jr., MBA
GenderThe person's gender.PMale
IDThe person's or organization's alphanumeric ID.P and O10039
Informal NameThe informal name, or nickname, for this person.PChris
Is MemberReturns a value of True if the contact is in an Is Member group. Members with expired memberships will have a value of False for the Is Member property.P and OTrue
Is OrganizationIndicates whether this party is an organization or a person.P and OFalse
Last NameThe person's last name.PBaker
Login Is DisabledIndicates whether this person's login has been disabled.PFalse
Middle NameThe person's middle name or initial.PT.
Party IdThe person's or organization's unique identifier.P and O28f6a0f8-2fd3-4049-962a-3cb068640bf0
Prefix The person's prefix (for example, Mr., Ms., Dr.). PMr.
*Primary Organization NameThe name of the primary organization associated with this party.POpus, Inc.
Primary Organization Party IdThe unique identifier of the primary organization associated with this person.P64371f11-b9cf-4b37-a6ff-b0a7056089a8
Sort NameThe name listed in an order typically used for sorting. For people, this is their name listed in LAST, FIRST order. For organizations, it is simply their full name in all caps.P and OBAKER, CHRIS
StatusThe person's or organization's status in the system (for example, Active, Delete). Note: This does not reflect the status of a party's membership, and is used primarily to denote contacts that are to be removed/inactivated permanently.P and OActive
SuffixThe person's suffix (for example, Jr., Sr.). PJr.
Tax ID NumberThe person's or organization's ID number used for tax purposes.P and O123456789
*TitleThe person's title.PPresident
UsernameThe person's username, if assigned.PCBAKER
FullAddressData

The FullAddressData business object stores provides basic address information for a specific party (person or organization). There can be multiple full addresses per person or organization. Each record represents the information for a specific address purposes, such as Home or Work.

Object 1Object 2ExampleJoin Property
PartyDataFullAddressDataFind the preferred billing address for a contactPartyId

FullAddressData properties

Properties can apply to people (P), organizations (O), or both.

* When using this business object as a source in the Intelligent Query Architect, this property is a default display column.

PropertyDescriptionApplies ToExample Data
Address Line 1The first address line of the physical address.P and OStonelake Building 1
Address Line 2The second address line of the physical address.P and O4030 W Braker Ln
Address Line 3The third address line of the physical address.P and OSuite 175
Address PurposeA description of this address’s use, such as Home, Work, or PO Box. This description is useful in discriminating among multiple addresses for the same person or organization.P and OWork
CityThe city portion of the physical address.P and OAustin
Country CodeThe short code indicating the country of the physical address.P and OUS
Country NameThe longer textual description of the country.P and OUnited States
CountyThe county portion of the physical address.P and OTravis
EmailThe email address associated with this address.P and O[email protected]
FaxThe facsimile telephone number associated with this address.P and O(555) 555-5555
*Formatted AddressThe full formatted address, using the Address Format defined for the country.P and OStonelake Building 1 4030 W Braker Ln Suite 175 Austin, TX 78759 United States
Full Address IDThe unique identifier of the related row in the FullAddress table for this address, for use in linking/joining with other business objects.P and Of784c48a-cf50-4c81-87b2-87d0d64a5512
Is Default Communication ReasonAn indication that this address is the default address for the person or organization. This is often referred to as the primary address.P and OTrue
Is Preferred BillingIndicates whether this is the preferred billing address for the person or organization.P and OTrue
Is Preferred MailingIndicates whether this is the preferred mailing address for the person or organization.P and OTrue
Is Preferred ShippingIndicates whether this is the preferred shipping address for the person or organization.P and OTrue
PhoneThe standard telephone number associated with this address.P and O(555) 555-5555
Postal CodeA series of characters used to identify an area within a country which contains the physical address.P and O78759
State Province CodeThe short code indicating the state or province of the physical address.P and OTX
State Province NameThe longer textual description of the state or province of the physical address.P and OTexas
Party IdThe unique identifier of the party associated with this address.P and Ob1df6115-2001-47a7-a0fd-0458f847d61a
PartyEventOccurrenceCheckinStatus

The PartyEventOccurrenceCheckinStatus business object returns a contact's current check-in status for an individual event occurrence, either a program item or recurring session.

📘 Note

This business object must always be used with a filter for either OccurrenceID or PartyID.
PartyEventOccurrenceAttendanceLog

The PartyEventOccurrenceAttendanceLog business object returns one row for every check-in and check-out of a contact to an event session (occurrence). Use the OccurrenceId property to join to EventOccurrenceData to get information about the parent program item and event.

Use for Full attendance history of the event occurrence. You can also identify or filter by the Party. To get counts of check-ins, you will have to filter on IsCheckedIn = TRUE or 1.

PartyEventOccurrenceAttendanceSummary

The PartyEventOccurrenceAttendanceSummary business objects returns one row per contact per event session (occurrence) which they attended, even if there are multiple check-ins or check-outs for that contact and event session. There will be no row if there is no check-in for the person and occurrence.

PartyEventOccurrenceAttendanceSummary also contains properties for the following:

  • Check-in date and time in various date formats.
  • Check-out date and time and the duration of attendance in minutes, if applicable.
  • Information about the event session, program item, and the event itself.

The check-out date time may be empty if there are no check-outs for that person and occurrence.

It can be joined to EventData using the EventId to get additional properties about the event.

📘 Note

This business object is intended mostly for use in aggregate functions such as counts and sums of attendees or total minutes spent in a session. If it is used to return detail row for attendance, make sure to filter the data by one or more properties.
PartyMembershipGroupData

The PartyMembershipGroupData business object provides information about Is Member group memberships. Parties with no Is Member memberships are included with null values for the group membership properties. This business object is intended to be joined with a Party business object.

PartyMembershipGroupData properties

Properties can apply to people (P), organizations (O), or both.

* When using this business object as a source in the Intelligent Query Architect, this property is a default display column.

PropertyDescriptionApplies ToExample Data
Expiration DateDate the contact's membership in an Is Member group expires.P and O6/22/17
Group IdThe unique identifier of the group.P and Ocb2a3f7f-c5cd-4f1d-81a8-1d376d479f62
Group Member IdThe unique identifier of the person or organization that is a member of the groupP and O7f4970e7-db18-41e9-b434-462e9ee2ab4f
Group NameThe name of the group.P and OAssociation Members
Is ActiveIndicates whether the person or organization has an active membership in the group.P and OTrue
Join DateThe date the person or organization joined the group.P and O6/22/17
Party IdThe person's or organization's unique identifier.P and O28f6a0f8-2fd3-4049-962a-3cb068640bf0
PartyMembershipStatus

The PartyMembershipStatus business object displays a contact’s membership status as either non-member, active, or inactive. This business object is intended to be joined with a Party business object. Easily access the PartyMembershipStatus business object from the Common sources area by clicking Membership status.

Common joins

Commonly joined with PartyBasicData, PartyMembershipGroupData, or any other Party business object.

Object 1Object 2ExampleJoin Property
PartyMembershipStatusPartyBasicDataEasily determine a contact’s membership status: Non-member, Active, or InactivePartyId
PartyMembershipStatus PartyMembershipGroupData Find the status of the members who are part of an Is Member groupPartyId

Properties

  • Membership Status
  • PartyId
PartyMembershipTenure

The PartyMembershipTenure business object displays a contact's amount of time in days, months, and years between their Join date and Expiration date in an Is Member group. This business object is intended to be joined with a Party business object. Easily access the PartyMembershipTenure business object from the Membership sources area by clicking Membership tenure.

Common joins

Commonly joined with PartyBasicData, PartyMembershipGroupData, or any other Party business object.

Object 1Object 2ExampleJoin Property
PartyMembershipTenurePartyBasicDataFind the tenure of all membersPartyId
PartyMembershipTenure PartyMembershipGroupData Find the tenure of the members who are part of an Is Member groupPartyId

Properties

  • Expiration Date
  • Join Date
  • PartyId
  • Tenure in Days
  • Tenure in Months
  • Tenure in Years
ContactSocialNetwork

Stores information about the Social Profile URLs for LinkedIn and Twitter.

Common joins

Some common joins include PartyData and SocialNetworkRef.

Common Joins
Business ObjectRelation
PartyDataPartyData.PartyId = ContactSocialNetwork.ContactKey
SocialNetworkRefSocialNetworkRef.SocialNetworkKey = ContactSocialNetwork.SocialNetworkKey

ContactSocialNetwork properties

ContactSocialNetwork properties:
Contact KeySocial Network KeySocial Network User IdUse Social Network Profile Photo
Contact Social Network KeySocial Network TokenSocial Network User Name
DateDimension

Contains a row for every day from 1/1/2000 to 12/31/2050 in order to more easily create reports and queries that require dates.

Common joins

Some common joins include:

Business ObjectRelation
InvoiceSummaryDateDimension.TheDate = InvocieSummary.InvoiceDate
NetContactDataDateDimension.TheDate = NetContactData.JoinDate

DateDimension properties

Property
DayOfCalenderYearFiscalYearEnd
DayOfMonthFiscalYearMonth
DayOfWeekLastDayOfMonth
FiscalMonthNextWorkingDay
FiscalYearTheDate
FiscalYearBegin
MonthRef

Contains a row for every calendar month in order to more easily create reports and queries that require dates.

Common joins

Some common joins include:

Business ObjectRelation
EngagementScoreMonthlyDataEngagementScoreMonthlyData.Score Month = MonthRef.Month Number
CsDonationsDetailCsDonationsDetail.Fiscal Month = MonthRef.Month Number

MonthRef properties

Property
MonthName
MonthNameShort
MonthNameUpper
MonthNameUpperShort
MonthNumber
YearRef

Contains a row for every year from 2000 to 2050 in order to more easily create reports and queries that require dates.

Common joins

Some common joins include:

Business ObjectRelation
EngagementScoreYearlyDataYearRef.Year = EngagementScoreYearlyData.ScoreYear
CsDonationsYearRef.Year = CsDonations.Fiscal Year

YearRef properties

Property
FiscalYearBegin
FiscalYearEnd
Year
YearChar
YearShort
YearShortChar
ItemData

Provides information for commerce items such as products, fundraising items and events. Includes information such as the name and type of the item, whether the item is charitable and which group and role the purchaser is assigned to, if applicable.

Common joins

Some common joins include ItemClassData, ItemSaleData, EventData, EventFunctionData, and GroupData.

Common Joins
Business ObjectRelation
ItemClassDataItemData.ItemClassId = ItemClassData.ItemClassId
ItemSaleDataItemData.ItemId = ItemSaleData.ItemId
EventDataItemData.ItemId = EventData.EventItemId
EventFunctionDataItemData.ItemId = EventFunctionData.FunctionItemId
GroupDataItemData.PurchaserGroupId = GroupData.GroupId

ItemData properties

ItemData Properties:
Accounting Method CodeItem Type NameCreated OnNameFair Market ValuePublish End Date
Has Physical InventoryPublish Start DateIncurs HandlingPurchaser Group IdIncurs RestockPurchaser Group Role Id
Incurs ShippingPurchaser Group Role NameIs CharitableRelated Content MessageIs Marked For DeleteStandard Cost
Item Class IdStatusItem Class NameTax Category IdItem CodeTax Schedule Id
Item IdUpdated OnItem Set TypeWeightItem Type Id
ItemClassData

Provides information for item classes.

Common joins

Commonly joined to ItemData.

Common Joins
Business ObjectRelation
ItemDataItemClassData.ItemClassId = ItemData.ItemClassId

ItemClassData properties

ItemClassData properties:
Is Marked For Delete
Item Class Id
Name
ItemSaleData

The ItemSaleData business object provides information for item sales, displays on row per item sold per transaction, and includes information such as the product sold, the bill-to and ship-to contacts for the transaction, the source code, and the amount of the order.

Common joins

Some common joins include ItemData and PartyData.

Common Joins
Business ObjectRelation
ItemDataItemSaleData.ItemId = ItemData.ItemId
PartyData

ItemSaleData.BillToPartyId = PartyData.PartyId

OR

ItemSaleData.SoldToPartyId = PartyData.PartyId

OR

ItemSaleData.ShipToPartyId = PartyData.PartyId

ItemSaleData properties

ItemSaleData properties:
Transaction DateItem Sale IdUndiscounted Extended AmountItem IdSource Code IdItem Name
DescriptionOrder DateBill To Party IdItem Type NameCreated OnList As
Invoice NumberQuantity SoleExtended AmountOrder NumberInvoice Line NumberProject Code
Is PledgeSource CodeInvoice TypeShip To Party IdIs CharitableSold To Party Id
DonationSummary

DonationSummary lists all gifts and pledges, and combines split gifts, pledge payments, installment pledges, and financial adjustments into one row per donation. Each row includes properties such as GiftType, which differentiates between gifts and pledges, and IsSplitGift, which denotes split gifts.

Common joins

Some common joins include:

Business ObjectRelation
NetContactDataDonationSummary.ID = NetContactData.Id

DonationSummary properties

Properties
AmountAmountPaidAppealBalance
CalendarYearCampaignDateReceivedEligibleAmount
FairMarketValueFiscalMonthFiscalYearGiftType
IdInstallmentsInvoiceIdInvoiceNumber
IsSplitGiftListAsMemorialNameTextMemorialTributeMessage
MemorialTributeTypeNoteOriginalTransactionRequestNumber
SolicitorIDTransactionDate
GiftTotalsByDate

The GiftTotalsByDate business object is used to report on the total number of gifts and the sum of the gift amounts for a given date.

GroupData

Provides information for groups. Includes information such as the name and class of the group, whether it is a membership group, a relationship group, or the owner of the group and its status.

Common joins

Commonly joined to GroupMemberData for more information on the group's members, or to ItemData to find items that will place purchasers in the group.

Common Joins
Business ObjectRelation
GroupMemberDataGroupData.GroupId = GroupMemberData.GroupId

GroupData properties

GroupData properties:
DescriptionIs Date LimitedIs SystemGroup Class IdIs Marked For DeleteName
Group Class NameIs MemberOwner IdGroup IdIs Relationship GroupOwner Type
Group StatusIs Simple GroupPriorityIs Auto GeneratedIs Single Role
GroupMemberData

This business object provides information for group members, such as the group's name, the member's name, whether the membership is active, when the member joined, and when their membership expires.

Common joins

Some common joins include GroupData, GroupMemberDetailData, and PartyData.

Common Joins
Business ObjectRelation
GroupDataGroupMemberData.GroupId = GroupData.GroupId
GroupMemberDetailDataGroupMemberData.GroupMemberId = GroupMemberDetailData.GroupMemberId
PartyDataGroupMemberData.PartyId = PartyData.PartyId

GroupMemberData properties

GroupMemberData properties:
Created OnIs Marked For DeleteExpiration DateJoin Date
Group IdParty Full NameGroup Member IdParty Id
Group NameUpdated OnIs Active
GroupMemberDetailData

Provides detailed information about group member's roles within the group. Might contain more than one row per group membership. Simple group memberships will not contain any detail rows. Includes information such as the group role name, effective date, expiration date, and reciprocal role information for relationship groups.

Common joins

Commonly joined to GroupMemberData.

Common Joins
Business ObjectRelation
GroupMemberDataGroupMemberDetailData.GroupMemberId = GroupMemberData.GroupMemberId

GroupMemberDetailData properties

GroupMemberDetailData properties:
Reciprocal Role DescriptionGroup Role NameStatus DescriptionGroup Role IdStatus Code
Expiration DateQuantityEffective DateIs Active
Group Member IdReciprocal Role NameGroup Member Detail IdReciprocal Role Id
EventData

Provides information about events. Includes information such as the event name and description, the start and end date and time, when the event is available in search, when registration starts and ends, cutoff dates, capacity, whether registering others is allowed, the address for the event, the ID for the group the registrants are added to, and the ID for the form (question) definition. The start and end date and time is based on the system Time zone setting.

Common joins

Some common joins include EventFunctionData, EventRegistrationData, and FormDefinitionFieldData.

Common Joins
Business ObjectRelation
EventFunctionDataEventData.EventId = EventFunctionData.EventId
EventRegistrationDataEventData.EventId = EventRegistrationData.EventId
FormDefinitionFieldData

EventData.FormDefinitionId = FormDefinitionFieldData

OR

EventData.FormDefinitionSectionId = FormDefinitionFieldData

EventData properties

EventData properties:
Additional Info HTMLForm Definition Section IdAllow GuestsImage URLAllow Register OthersLocation Address
CapacityLocation EmailDescriptionLocation Phone NumberEarly Cutoff DatePublish State Date Time
End Date TimePublish Expiration Date TimeEvent Group IdRegistration End Date TimeEvent IdRegistration Type
Event Item IdRegistration Type IdEvent NameRegular Cutoff DateForm Definition IdStart Date Time
Event category Id
EventFunctionData

Provides information for event registration options and program items. Includes information such as the function name, the event name, the start and end date and time, capacity, and the ID for the form (question) section definition. The start and end date and time is based on the system Time zone setting.

Common joins

Some common joins include EventData, EventFunctionRegistrationData, EventRegistrationFinancialData, GroupData, and FormDefinitionFieldData.

Common Joins
Business ObjectRelation
EventDataEventFunctionData.EventId = EventData.EventId
EventFunctionRegistrationDataEventFunctionData.EventFunctionId = EventFunctionRegistrationData.FunctionId
EventRegistrationFinancialDataEventFunctionData.EventFunctionId = EventFunctionFinancialData.EventFunctionId
GroupDataEventFunctionData.FunctionGroupId = GroupData.GroupId
FormDefinitionFieldDataEventFunctionData.FormDefinitionSectionId = FormDefinitionFieldData.FormDefinitionSectionId

EventFunctionData properties

EventFunctionData properties:
Additional Info HTMLFormatted AddressFunction Item IdStart Date TimeForm Definition Section IdFunction IdSort Order
End Date TimeFunction Category NameIs Registration OptionCapacityFunction Category IdFunction Name
Event NameFunction Group IdRegistration Type CodeEvent IdFunction DescriptionRegistration Type
EventRegistrationData

Provides information for event registrations. Includes information such as the registrant's name, event name, registration status and date, the selected registration option, and the ID for the form (question) responses.

Common joins

Some common joins include EventData, EventFunctionRegistrationData, EventRegistrationFinancialData, PartyData, GroupData, GroupMemberData, and FormFieldResponseData.

Common Joins
Business ObjectRelation
EventDataEventRegistrationData.EventId = EventData.EventId
EventFunctionRegistrationData

EventRegistrationData.EventId = EventFunctionRegistrationData.EventId

AND

EventRegistrationData.RegistrantPartyId = EventFunctionRegistrationData.RegistrantPartyId

EventRegistrationFinancialData

EventRegistrationData.EventId = EventRegistrationFinancialData.EventId

AND

EventRegistrationData.RegistrantPartyId = EventRegistrationFinancialData.RegistrantPartyId

PartyDataEventRegistrationData.PartyId = PartyData.PartyId
GroupDataEventRegistrationData.GroupId = GroupData.GroupId
GroupMemberDataEventRegistrationData.GroupMemberId = GroupMemberData.GroupMemberId
FormFieldResponseDataEventRegistrationData.FormResponseId = FormFieldResponseData.FormResponseId

EventRegistrationData properties

EventRegistrationData properties:

Event IdGroup Member Status CodeRegistration Option NameGroup Member StatusRegistration Option Function Id
Form Response IdRegistration Full NameEvent NameIs Active
Group Member IdRegistration DateGroup IdRegistration Party Id
EventFunctionRegistrationData

Provides information for event registration option and program item registrations. Includes information such as the registrant's name, the function name and type, the function group membership, and the registration date.

Common joins

Some common joins include EventData, EventFunctionData, EventRegistrationData, GroupData, GroupMemberData, EventRegistrationFinancialData, and PartyData.

Business ObjectRelation
EventDataEventFunctionRegistrationData.EventId = EventData.EventId
EventFunctionDataEventFunctionRegistrationData.FunctionId = EventFunctionData.FunctionId
EventRegistrationData

EventFunctionRegistrationData.EventId = EventRegistrationData.EventId

AND

EventFunctionRegistrationData.RegistrantPartyId = EventRegistrationData.RegistrantPartyId

EventRegistrationFinancialData

EventFunctionRegistrationData.FunctionId = EventRegistrationFinancialData.FuncitonId

AND

EventFunctionRegistrationData.RegistrantPartyId = EventRegistrationFinancialData.RegistrantPartyId

GroupDataEventFunctionRegistrationData.GroupId = GroupData.GroupId
GroupMemberDataEventFunctionRegistrationData.GroupMemberId = GroupMemberData.GroupMemberId
PartyDataEventFunctionRegistrationData.RegistrantPartyId = PartyData.PartyId

EventFunctionRegistrationData properties

EventFunctionRegistrationData properties:

Item IdGroup Member IdRegistrant Full NameFunction IdIs Active
Event NameGroup Member Status CodeRegistration DateGroup IdQuantity
Function NameIs Registration OptionEvent IdGroup Member StatusRegistrant Party Id
EventRegistrationFinancialData

Provides financial information for event function registrations. Includes information such as the event name, event function name and registrant name, how much the registration cost, and the remaining balance.

Common joins

Some common joins include EventData, EventFunctionData, EventRegistrationData, EventFunctionRegistrationData, or PartyData.

Business ObjectRelation
EventDataEventRegistrationFinancialData.EventId = EventData.EventId
EventFunctionDataEventRegistrationFinancialData.EventFunctionId = EventFunctionData.FunctionId
EventRegistrationData

EventRegistrationFinancialData.EventId = EventRegistrationData.EventId

AND

EventRegistrationFinancialData.PartyId = EventRegistrationData.PartyId

EventFunctionRegistrationData

EventRegistrationFinancialData.EventFunctionId = EventFunctionRegistrationData.FunctionId

AND

EventRegistrationFinancialData.RegistrantPartyId = EventRegistrationData.RegistrantPartyId

PartyDataEventRegistrationFinancialData.RegistrantPartyId = PartyData.PartyId

EventRegistrationFinancialData properties

EventRegistrationFinancialData properties:
BalanceEvent NameEvent Function IdExtended Amount
Event Function Item IdIs Event Registration OptionEvent Function NamePayment Amount Applied
Event Function Registration Type CodeRegistrant Full NameEvent IdRegistrant Party Id
OpenCreditData

Provides information for open credits. Includes information such as the ID for the credit recipient and the credit amount. This might contain more than one line per recipient.

Common joins

Commonly joined with PartyData.

Business ObjectRelation
PartyDataOpenCreditData.PayorPartyId = PartyData.PartyId

OpenCreditData properties

OpenCreditData properties:
AmountCredit AmountPayment Id
Applied AmountPayment DatePayor Party Id
OrderData

Provides information for orders. Includes information such as the order number and date, discount code and discount amount, source code, and sold to/bill to contact IDs.

Common joins

Some common joins include OrderLineData, PartyData, or FullAddressData.

Business ObjectRelation
OrderLineDataOrderData.OrderId = OrderLineData.OrderId
PartyData

OrderData.BillToPartyId = PartyData.PartyId

OR

OrderData.SoldToPartyId = PartyData.PartyId

FullAddressData

OrderData.BillToAddressId = FullAddressData.FullAddressI

OR

OrderData.SoldToAddressId = FullAddressData.FullAddressId

OrderData properties

OrderData properties:
Currency CodeLine TotalPrice Sheet IdSource Code IdDiscount AmountOrder IdSold To Full Address Id
Bill To Party IdOrder DateShipping TotalTax TotalFinancial Entity IdOrder TotalSource Code
Discount CodeOrder NumberSold To Party IdBill To Full Address IdMisc Charge TotalSales Team Group IdStatus
OrderLineData

Provides information for order lines. Includes information such as the order number, order line number, item name, quantity sold, amount, discount code, status, and ship to contact ID.

Common joins

Some common joins include OrderData, ItemData, ItemClassData, PartyData, or FullAddressData.

Business ObjectRelation
OrderDataOrderLineData.OrderId = OrderData.OrderId
ItemDataOrderLineData.ItemId = ItemData.ItemId
ItemClassDataOrderLineData.ItemClassId = ItemClassData.ItemClassId
PartyDataOrderLineData.ShipToPartyId = PartyData.PartyId
FullAddressDataOrderLineData.ShipToAddresId = FullAddressData.FullAddressId

OrderLineData properties

OrderLineData properties:
Item IdItem NameParent Order Line IdStatusExtended AmountSequence Order Line Number
Discount AmountItem Set Type NameQuantityUnit PriceItem Class IdShip To Party Id
Display Order Line NumberOrder IdSales Team Group IdBase PriceItem Set Type CodeTax Schedule Id
Is PledgeOrder Line NumberShip To Full Address IdDiscount CodeItem Type Name
UserData

Provides information about users. This will only apply to contacts who have a login account. Includes information such as the user's name and username, whether they are locked out, last login, activity and lockout date, and whether they are a staff or an admin user.

📘 Note

Any dates that show up in the UserData business object default to Coordinated Universal Time (UTC). To change to your local time zone, go to Settings > RiSE > Quick Setup > Time zone if you have not set it already.

Common joins

Commonly joined with PartyData.

Business ObjectRelation
PartyDataUserData.PartyId = PartyData.PartyId

UserData properties

UserData properties:
Created OnIs Locked OutEffective DateIs Staff
EmailLast Activity DateExpiration DateLast Login Date
Failed Password Attempt CountLast Password Changed DateIs AdminParty Full Name
Is ApprovedParty IdIs DisabledUsername
InvoiceData

Provides information for invoices. Includes information such as the invoice number, date, description, shipping method, promotion code, source code used, the invoice totals, and the purpose for the invoice such as Regular, SubscriptionBilling (used for renewals), or AutoPayPledge (used for recurring donations).

Common joins

Some common joins include InvoiceLineData, PartyData, or FullAddressData.

Business ObjectRelation
InvoiceLineDataInvoiceData.InvoiceId = InvoiceLineData.InvoiceId
PartyData

InvoiceData.BillToPartyId = PartyData.PartyId

OR

InvoiceData.SoldToPartyId = PartyData.PartyId

OR

InvoiceData.ShipToPartyId = PartyData.PartyId

FullAddressDataInvoiceData.ShipToAddressId = FullAddress.FullAddressId

InvoiceData properties

InvoiceData properties:
Currency CodeAccounting MethodAdjustments AppliedApplied To InvoicesBalanceBase Line TotalBill To Party IdCreated By
Created OnDescriptionDue DateFinancial Entity IdFinancial Entity NameFinancial Entity Party IdHandlingInvoice Date
Invoice IdInvoice NumberInvoice PurposeInvoice Report TypeInvoice TotalInvoice Type DescLine TotalLogo Image Description
Multiple Installment PaymentsMultiple Ship TosOrder NumberOriginal Invoice NumberPayment Terms NamePayments AppliedPending Payment Adjustment AmountPrice Sheet Name
Promo CodeRestockingShip MethodShip To Full Address IdShip To Party IdShippingSignature Image DescriptionSignature Image URL
Sold To Party IdSource CodeTax Receipt MessageTotal DiscountUpdated ByUpdated OnWeight
InvoiceLineData

Provides information for invoice lines. Includes information such as the item, quantity sold, total amount, payments applied, remaining balance, source and promotion codes used, and the ship to contact's ID.

Common joins

Some common joins include InvoiceData, ItemData, PartyData, or FullAddressData.

Business ObjectRelation
InvoiceDataInvoiceLineData.InvoiceId = InvoiceData.InvoiceId
ItemDataInvoiceLineData.ItemId = ItemData.ItemId
PartyDataInvoiceLineData.ShipToPartyId = PartyData.PartyId
FullAddressDataInvoiceLineData.ShipToAddressId = FullAddressData.FullAddressId

InvoiceLineData properties

InvoiceLineData properties:
Customer Country CodeHas Child Invoice LinesOrder Line NumberInvoice IdInvoice Line IdParent Invoice Line Number
Item IdInvoice Line NumberPayment Amount AppliedAdjustment Amount AppliedInvoice NumberQuantity
Applied to InvoicesIs Event ProductRateBalanceIs Event Registration OptionRoot Invoice Line Number
Base PriceItem NameShip To Full Address IdExempt AmountLevelShip To Party Id
Exemption ReasonLine Price Sheet NameTax Authority NameExemption Registration NumberLine Promo CodeTax Category Name
Extended AmountLine Ship MethodUnit PriceExtended Base PriceLine Source CodeUom Name
FormDefinitionFieldData

Provides information about form definitions including the overall form, each section, and each field. Includes information such as the sequence number for each section and field, the field caption, and response data type (such as integer, decimal, string, boolean or datetime).

Common joins

Some common joins include EventData, EventFunctionData, or FormFieldResponseData.

Business ObjectRelation
EventData

FormDefinitionFieldData.FormDefinitionId = EventData.FormDefinitionId

OR

FormDefinitionFieldData.FormDefinitionSectionId = EventData.FormDefintionSectionId

EventFunctionDataFormDefinitionFieldData.FormDefinitionSectionId = EventFunctionData.FormDefinitionSectionId
FormFieldResponseDataFormDefinitionFieldData.FormDefinitionFieldId = FormFieldResponseData.FromDefinitionFieldId

FormDefinitionFieldData properties

FormDefinitionFieldData properties:
Form Definition Field CaptionForm Definition Field Id
Form Definition Field SequenceForm Definition Field Type
Form Definition IdForm Definition Section Id
Form Definition Section Sequence
FormFieldResponseData

Provides information for the responses to form questions. Includes information such as the form field question and answer. Note that there are separate properties for each response type that will contain data for just that type, but there is also a property labeled Response that combines all of these answer types into a single column as a string value.

Common joins

Some common joins include EventRegistrationData or PartyData.

Business ObjectRelation
EventRegistrationDataFormFieldResponoseData.FormResponseId = EventRegistrationData.FormResponseId
PartyDataFormFieldResponoseData.PartyId = PartyData.PartyId

FormFieldResponseData properties

FormFieldResponseData properties:
Field Boolean ValueForm Definition Field IdField Date Time ValueForm Response Field Id
Field Decimal ValueForm Response IdField Integer ValueParty Id
Field String ValueResponseForm Definition Field Caption

New property names

Here is a list of the new property names with the compatible older properties:

New NameOld Name
PartyIdContactKey, UserKey
AddressIdAddressKey
ItemIdProductKey
ItemClassIdProductClassKey
ItemSaleIdSalesHistoryKey
EventIdEventKey
EventFunctionIdEventFunctionKey
GroupIdGroupKey
GroupMemberIdGroupMemberKey
GroupMemberDetailIdGroupMemberDetailKey
GroupRoleIdGroupRoleKey
InvoiceIdInvoiceKey
InvoiceLineIdInvoiceLineKey
OrderIdOrderKey
OrderLineIdOrderLineKey


Did this page help you?