Getting started with IQA queries: Business Objects
WarningPoorly 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.
NoteTo 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 Object | Details |
|---|---|
| PartyBasicData |
|
| PartyData |
|
| PartyWithDefaultAddressData |
|
| Contact |
|
| Individual |
|
| Institute |
|
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.
‡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.
| Property | Description | Applies To‡ | Example Data |
|---|---|---|---|
| Birth Date | The person's date of birth. | P | 1/21/1971 |
| Designation | The person's designation (for example, PhD, MD, CPA). | P | MBA |
| First Name | The person's first name. | P | Christopher |
| *Full Name | The 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 O | Mr. Christopher T. Baker, Jr., MBA |
| Gender | The person's gender. | P | Male |
| ID | The person's or organization's alphanumeric ID. | P and O | 10039 |
| Informal Name | The informal name, or nickname, for this person. | P | Chris |
| Is Member | Returns 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 O | True |
| Is Organization | Indicates whether this party is an organization or a person. | P and O | False |
| Last Name | The person's last name. | P | Baker |
| Login Is Disabled | Indicates whether this person's login has been disabled. | P | False |
| Middle Name | The person's middle name or initial. | P | T. |
| Party Id | The person's or organization's unique identifier. | P and O | 28f6a0f8-2fd3-4049-962a-3cb068640bf0 |
| Prefix | The person's prefix (for example, Mr., Ms., Dr.). | P | Mr. |
| *Primary Organization Name | The name of the primary organization associated with this party. | P | Opus, Inc. |
| Primary Organization Party Id | The unique identifier of the primary organization associated with this person. | P | 64371f11-b9cf-4b37-a6ff-b0a7056089a8 |
| Sort Name | The 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 O | BAKER, CHRIS |
| Status | The 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 O | Active |
| Suffix | The person's suffix (for example, Jr., Sr.). | P | Jr. |
| Tax ID Number | The person's or organization's ID number used for tax purposes. | P and O | 123456789 |
| *Title | The person's title. | P | President |
| Username | The person's username, if assigned. | P | CBAKER |
| Address Line 1 | The first address line of the physical address. | P and O | Stonelake Building 1 |
| Address Line 2 | The second address line of the physical address. | P and O | 4030 W Braker Ln |
| Address Line 3 | The third address line of the physical address. | P and O | Suite 175 |
| Address Purpose | A 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 O | Work |
| City | The city portion of the physical address. | P and O | Austin |
| Country Code | The short code indicating the country of the physical address. | P and O | US |
| Country Name | The longer textual description of the country. | P and O | United States |
| County | The county portion of the physical address. | P and O | Travis |
| The email address associated with this address. | P and O | [email protected] | |
| Fax | The facsimile telephone number associated with this address. | P and O | (555) 555-5555 |
| *Formatted Address | The full formatted address, using the Address Format defined for the country. | P and O | Stonelake Building 1 4030 W Braker Ln Suite 175 Austin, TX 78759 United States |
| Phone | The standard telephone number associated with this address. | P and O | (555) 555-5555 |
| Postal Code | A series of characters used to identify an area within a country which contains the physical address. | P and O | 78759 |
| State Province Code | The short code indicating the state or province of the physical address. | P and O | TX |
| State Province Name | The longer textual description of the state or province of the physical address. | P and O | Texas |
PartyData
The PartyData business object provides basic information about a person or organization.
| Business Object | Relation |
|---|---|
| FullAddressData | PartyData.PartyId = FullAddressData.PartyId |
| GroupMemberData | PartyData.PartyId = GroupMemberData.PartyId |
| EventRegistrationData | PartyData.PartyId = EventRegistrationData.RegistrantPartyId |
| EventFunctionRegistrationData | PartyData.PartyId = EventFunctionRegistrationData.RegistrantPartyId |
| EventRegistrationFinancialData | PartyData.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 |
| InvoiceLineData | PartyData.PartyId = InvoiceLineData.ShipToPartyId |
| OrderData | PartyData.PartyIdOrder = Data.BillToPartyId OR PartyData.PartyId = OrderData.SoldToPartyId |
| OrderLineData | PartyData.PartyId = OrderLineData.SoldToPartyId |
| UserData | PartyData.PartyId = UserData.PartyId |
‡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.
| Property | Description | Applies To‡ | Example Data |
|---|---|---|---|
| Birth Date | The person's date of birth. | P | 1/21/1971 |
| Designation | The person's designation (for example, PhD, MD, CPA). | P | MBA |
| First Name | The person's first name. | P | Christopher |
| *Full Name | The 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 O | Mr. Christopher T. Baker, Jr., MBA |
| Gender | The person's gender. | P | Male |
| ID | The person's or organization's alphanumeric ID. | P and O | 10039 |
| Informal Name | The informal name, or nickname, for this person. | P | Chris |
| Is Member | Returns 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 O | True |
| Is Organization | Indicates whether this party is an organization or a person. | P and O | False |
| Last Name | The person's last name. | P | Baker |
| Login Is Disabled | Indicates whether this person's login has been disabled. | P | False |
| Middle Name | The person's middle name or initial. | P | T. |
| Party Id | The person's or organization's unique identifier. | P and O | 28f6a0f8-2fd3-4049-962a-3cb068640bf0 |
| Prefix | The person's prefix (for example, Mr., Ms., Dr.). | P | Mr. |
| *Primary Organization Name | The name of the primary organization associated with this party. | P | Opus, Inc. |
| Primary Organization Party Id | The unique identifier of the primary organization associated with this person. | P | 64371f11-b9cf-4b37-a6ff-b0a7056089a8 |
| Sort Name | The 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 O | BAKER, CHRIS |
| Status | The 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 O | Active |
| Suffix | The person's suffix (for example, Jr., Sr.). | P | Jr. |
| Tax ID Number | The person's or organization's ID number used for tax purposes. | P and O | 123456789 |
| *Title | The person's title. | P | President |
| Username | The person's username, if assigned. | P | CBAKER |
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 1 | Object 2 | Example | Join Property |
|---|---|---|---|
| PartyData | FullAddressData | Find the preferred billing address for a contact | PartyId |
‡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.
| Property | Description | Applies To‡ | Example Data |
|---|---|---|---|
| Address Line 1 | The first address line of the physical address. | P and O | Stonelake Building 1 |
| Address Line 2 | The second address line of the physical address. | P and O | 4030 W Braker Ln |
| Address Line 3 | The third address line of the physical address. | P and O | Suite 175 |
| Address Purpose | A 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 O | Work |
| City | The city portion of the physical address. | P and O | Austin |
| Country Code | The short code indicating the country of the physical address. | P and O | US |
| Country Name | The longer textual description of the country. | P and O | United States |
| County | The county portion of the physical address. | P and O | Travis |
| The email address associated with this address. | P and O | [email protected] | |
| Fax | The facsimile telephone number associated with this address. | P and O | (555) 555-5555 |
| *Formatted Address | The full formatted address, using the Address Format defined for the country. | P and O | Stonelake Building 1 4030 W Braker Ln Suite 175 Austin, TX 78759 United States |
| Full Address ID | The unique identifier of the related row in the FullAddress table for this address, for use in linking/joining with other business objects. | P and O | f784c48a-cf50-4c81-87b2-87d0d64a5512 |
| Is Default Communication Reason | An indication that this address is the default address for the person or organization. This is often referred to as the primary address. | P and O | True |
| Is Preferred Billing | Indicates whether this is the preferred billing address for the person or organization. | P and O | True |
| Is Preferred Mailing | Indicates whether this is the preferred mailing address for the person or organization. | P and O | True |
| Is Preferred Shipping | Indicates whether this is the preferred shipping address for the person or organization. | P and O | True |
| Phone | The standard telephone number associated with this address. | P and O | (555) 555-5555 |
| Postal Code | A series of characters used to identify an area within a country which contains the physical address. | P and O | 78759 |
| State Province Code | The short code indicating the state or province of the physical address. | P and O | TX |
| State Province Name | The longer textual description of the state or province of the physical address. | P and O | Texas |
| Party Id | The unique identifier of the party associated with this address. | P and O | b1df6115-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.
‡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.
| Property | Description | Applies To‡ | Example Data |
|---|---|---|---|
| Expiration Date | Date the contact's membership in an Is Member group expires. | P and O | 6/22/17 |
| Group Id | The unique identifier of the group. | P and O | cb2a3f7f-c5cd-4f1d-81a8-1d376d479f62 |
| Group Member Id | The unique identifier of the person or organization that is a member of the group | P and O | 7f4970e7-db18-41e9-b434-462e9ee2ab4f |
| Group Name | The name of the group. | P and O | Association Members |
| Is Active | Indicates whether the person or organization has an active membership in the group. | P and O | True |
| Join Date | The date the person or organization joined the group. | P and O | 6/22/17 |
| Party Id | The person's or organization's unique identifier. | P and O | 28f6a0f8-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 1 | Object 2 | Example | Join Property |
|---|---|---|---|
| PartyMembershipStatus | PartyBasicData | Easily determine a contact’s membership status: Non-member, Active, or Inactive | PartyId |
| PartyMembershipStatus | PartyMembershipGroupData | Find the status of the members who are part of an Is Member group | PartyId |
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 1 | Object 2 | Example | Join Property |
|---|---|---|---|
| PartyMembershipTenure | PartyBasicData | Find the tenure of all members | PartyId |
| PartyMembershipTenure | PartyMembershipGroupData | Find the tenure of the members who are part of an Is Member group | PartyId |
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 Object | Relation |
| PartyData | PartyData.PartyId = ContactSocialNetwork.ContactKey |
| SocialNetworkRef | SocialNetworkRef.SocialNetworkKey = ContactSocialNetwork.SocialNetworkKey |
| ContactSocialNetwork properties: | |||
|---|---|---|---|
| Contact Key | Social Network Key | Social Network User Id | Use Social Network Profile Photo |
| Contact Social Network Key | Social Network Token | Social 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 Object | Relation |
|---|---|
| InvoiceSummary | DateDimension.TheDate = InvocieSummary.InvoiceDate |
| NetContactData | DateDimension.TheDate = NetContactData.JoinDate |
DateDimension properties
| Property | |
|---|---|
| DayOfCalenderYear | FiscalYearEnd |
| DayOfMonth | FiscalYearMonth |
| DayOfWeek | LastDayOfMonth |
| FiscalMonth | NextWorkingDay |
| FiscalYear | TheDate |
| 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 Object | Relation |
|---|---|
| EngagementScoreMonthlyData | EngagementScoreMonthlyData.Score Month = MonthRef.Month Number |
| CsDonationsDetail | CsDonationsDetail.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 Object | Relation |
|---|---|
| EngagementScoreYearlyData | YearRef.Year = EngagementScoreYearlyData.ScoreYear |
| CsDonations | YearRef.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 Object | Relation |
| ItemClassData | ItemData.ItemClassId = ItemClassData.ItemClassId |
| ItemSaleData | ItemData.ItemId = ItemSaleData.ItemId |
| EventData | ItemData.ItemId = EventData.EventItemId |
| EventFunctionData | ItemData.ItemId = EventFunctionData.FunctionItemId |
| GroupData | ItemData.PurchaserGroupId = GroupData.GroupId |
| ItemData Properties: | |||||
|---|---|---|---|---|---|
| Accounting Method Code | Item Type Name | Created On | Name | Fair Market Value | Publish End Date |
| Has Physical Inventory | Publish Start Date | Incurs Handling | Purchaser Group Id | Incurs Restock | Purchaser Group Role Id |
| Incurs Shipping | Purchaser Group Role Name | Is Charitable | Related Content Message | Is Marked For Delete | Standard Cost |
| Item Class Id | Status | Item Class Name | Tax Category Id | Item Code | Tax Schedule Id |
| Item Id | Updated On | Item Set Type | Weight | Item Type Id | |
ItemClassData
Provides information for item classes.
Common joins
Commonly joined to ItemData.
| Common Joins | |
|---|---|
| Business Object | Relation |
| ItemData | ItemClassData.ItemClassId = ItemData.ItemClassId |
| 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 Object | Relation |
| ItemData | ItemSaleData.ItemId = ItemData.ItemId |
| PartyData | ItemSaleData.BillToPartyId = PartyData.PartyId OR ItemSaleData.SoldToPartyId = PartyData.PartyId OR ItemSaleData.ShipToPartyId = PartyData.PartyId |
| ItemSaleData properties: | |||||
|---|---|---|---|---|---|
| Transaction Date | Item Sale Id | Undiscounted Extended Amount | Item Id | Source Code Id | Item Name |
| Description | Order Date | Bill To Party Id | Item Type Name | Created On | List As |
| Invoice Number | Quantity Sole | Extended Amount | Order Number | Invoice Line Number | Project Code |
| Is Pledge | Source Code | Invoice Type | Ship To Party Id | Is Charitable | Sold 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 Object | Relation |
|---|---|
| NetContactData | DonationSummary.ID = NetContactData.Id |
DonationSummary properties
| Properties | |||
|---|---|---|---|
| Amount | AmountPaid | Appeal | Balance |
| CalendarYear | Campaign | DateReceived | EligibleAmount |
| FairMarketValue | FiscalMonth | FiscalYear | GiftType |
| Id | Installments | InvoiceId | InvoiceNumber |
| IsSplitGift | ListAs | MemorialNameText | MemorialTributeMessage |
| MemorialTributeType | Note | OriginalTransaction | RequestNumber |
| SolicitorID | TransactionDate | ||
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 Object | Relation |
| GroupMemberData | GroupData.GroupId = GroupMemberData.GroupId |
| GroupData properties: | |||||
|---|---|---|---|---|---|
| Description | Is Date Limited | Is System | Group Class Id | Is Marked For Delete | Name |
| Group Class Name | Is Member | Owner Id | Group Id | Is Relationship Group | Owner Type |
| Group Status | Is Simple Group | Priority | Is Auto Generated | Is 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 Object | Relation |
| GroupData | GroupMemberData.GroupId = GroupData.GroupId |
| GroupMemberDetailData | GroupMemberData.GroupMemberId = GroupMemberDetailData.GroupMemberId |
| PartyData | GroupMemberData.PartyId = PartyData.PartyId |
| GroupMemberData properties: | |||
|---|---|---|---|
| Created On | Is Marked For Delete | Expiration Date | Join Date |
| Group Id | Party Full Name | Group Member Id | Party Id |
| Group Name | Updated On | Is 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 Object | Relation |
| GroupMemberData | GroupMemberDetailData.GroupMemberId = GroupMemberData.GroupMemberId |
| GroupMemberDetailData properties: | ||||
|---|---|---|---|---|
| Reciprocal Role Description | Group Role Name | Status Description | Group Role Id | Status Code |
| Expiration Date | Quantity | Effective Date | Is Active | |
| Group Member Id | Reciprocal Role Name | Group Member Detail Id | Reciprocal 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 Object | Relation |
| EventFunctionData | EventData.EventId = EventFunctionData.EventId |
| EventRegistrationData | EventData.EventId = EventRegistrationData.EventId |
| FormDefinitionFieldData | EventData.FormDefinitionId = FormDefinitionFieldData OR EventData.FormDefinitionSectionId = FormDefinitionFieldData |
| EventData properties: | |||||
|---|---|---|---|---|---|
| Additional Info HTML | Form Definition Section Id | Allow Guests | Image URL | Allow Register Others | Location Address |
| Capacity | Location Email | Description | Location Phone Number | Early Cutoff Date | Publish State Date Time |
| End Date Time | Publish Expiration Date Time | Event Group Id | Registration End Date Time | Event Id | Registration Type |
| Event Item Id | Registration Type Id | Event Name | Regular Cutoff Date | Form Definition Id | Start 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 Object | Relation |
| EventData | EventFunctionData.EventId = EventData.EventId |
| EventFunctionRegistrationData | EventFunctionData.EventFunctionId = EventFunctionRegistrationData.FunctionId |
| EventRegistrationFinancialData | EventFunctionData.EventFunctionId = EventFunctionFinancialData.EventFunctionId |
| GroupData | EventFunctionData.FunctionGroupId = GroupData.GroupId |
| FormDefinitionFieldData | EventFunctionData.FormDefinitionSectionId = FormDefinitionFieldData.FormDefinitionSectionId |
| EventFunctionData properties: | ||||||
|---|---|---|---|---|---|---|
| Additional Info HTML | Formatted Address | Function Item Id | Start Date Time | Form Definition Section Id | Function Id | Sort Order |
| End Date Time | Function Category Name | Is Registration Option | Capacity | Function Category Id | Function Name | |
| Event Name | Function Group Id | Registration Type Code | Event Id | Function Description | Registration 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 Object | Relation |
| EventData | EventRegistrationData.EventId = EventData.EventId |
| EventFunctionRegistrationData | EventRegistrationData.EventId = EventFunctionRegistrationData.EventId AND EventRegistrationData.RegistrantPartyId = EventFunctionRegistrationData.RegistrantPartyId |
| EventRegistrationFinancialData | EventRegistrationData.EventId = EventRegistrationFinancialData.EventId AND EventRegistrationData.RegistrantPartyId = EventRegistrationFinancialData.RegistrantPartyId |
| PartyData | EventRegistrationData.PartyId = PartyData.PartyId |
| GroupData | EventRegistrationData.GroupId = GroupData.GroupId |
| GroupMemberData | EventRegistrationData.GroupMemberId = GroupMemberData.GroupMemberId |
| FormFieldResponseData | EventRegistrationData.FormResponseId = FormFieldResponseData.FormResponseId |
EventRegistrationData properties: | ||||
|---|---|---|---|---|
| Event Id | Group Member Status Code | Registration Option Name | Group Member Status | Registration Option Function Id |
| Form Response Id | Registration Full Name | Event Name | Is Active | |
| Group Member Id | Registration Date | Group Id | Registration 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 Object | Relation |
|---|---|
| EventData | EventFunctionRegistrationData.EventId = EventData.EventId |
| EventFunctionData | EventFunctionRegistrationData.FunctionId = EventFunctionData.FunctionId |
| EventRegistrationData | EventFunctionRegistrationData.EventId = EventRegistrationData.EventId AND EventFunctionRegistrationData.RegistrantPartyId = EventRegistrationData.RegistrantPartyId |
| EventRegistrationFinancialData | EventFunctionRegistrationData.FunctionId = EventRegistrationFinancialData.FuncitonId AND EventFunctionRegistrationData.RegistrantPartyId = EventRegistrationFinancialData.RegistrantPartyId |
| GroupData | EventFunctionRegistrationData.GroupId = GroupData.GroupId |
| GroupMemberData | EventFunctionRegistrationData.GroupMemberId = GroupMemberData.GroupMemberId |
| PartyData | EventFunctionRegistrationData.RegistrantPartyId = PartyData.PartyId |
EventFunctionRegistrationData properties: | ||||
|---|---|---|---|---|
| Item Id | Group Member Id | Registrant Full Name | Function Id | Is Active |
| Event Name | Group Member Status Code | Registration Date | Group Id | Quantity |
| Function Name | Is Registration Option | Event Id | Group Member Status | Registrant 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 Object | Relation |
|---|---|
| EventData | EventRegistrationFinancialData.EventId = EventData.EventId |
| EventFunctionData | EventRegistrationFinancialData.EventFunctionId = EventFunctionData.FunctionId |
| EventRegistrationData | EventRegistrationFinancialData.EventId = EventRegistrationData.EventId AND EventRegistrationFinancialData.PartyId = EventRegistrationData.PartyId |
| EventFunctionRegistrationData | EventRegistrationFinancialData.EventFunctionId = EventFunctionRegistrationData.FunctionId AND EventRegistrationFinancialData.RegistrantPartyId = EventRegistrationData.RegistrantPartyId |
| PartyData | EventRegistrationFinancialData.RegistrantPartyId = PartyData.PartyId |
| EventRegistrationFinancialData properties: | |||
|---|---|---|---|
| Balance | Event Name | Event Function Id | Extended Amount |
| Event Function Item Id | Is Event Registration Option | Event Function Name | Payment Amount Applied |
| Event Function Registration Type Code | Registrant Full Name | Event Id | Registrant 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 Object | Relation |
|---|---|
| PartyData | OpenCreditData.PayorPartyId = PartyData.PartyId |
| OpenCreditData properties: | ||
|---|---|---|
| Amount | Credit Amount | Payment Id |
| Applied Amount | Payment Date | Payor 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 Object | Relation |
|---|---|
| OrderLineData | OrderData.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: | ||||||
|---|---|---|---|---|---|---|
| Currency Code | Line Total | Price Sheet Id | Source Code Id | Discount Amount | Order Id | Sold To Full Address Id |
| Bill To Party Id | Order Date | Shipping Total | Tax Total | Financial Entity Id | Order Total | Source Code |
| Discount Code | Order Number | Sold To Party Id | Bill To Full Address Id | Misc Charge Total | Sales Team Group Id | Status |
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 Object | Relation |
|---|---|
| OrderData | OrderLineData.OrderId = OrderData.OrderId |
| ItemData | OrderLineData.ItemId = ItemData.ItemId |
| ItemClassData | OrderLineData.ItemClassId = ItemClassData.ItemClassId |
| PartyData | OrderLineData.ShipToPartyId = PartyData.PartyId |
| FullAddressData | OrderLineData.ShipToAddresId = FullAddressData.FullAddressId |
| OrderLineData properties: | |||||
|---|---|---|---|---|---|
| Item Id | Item Name | Parent Order Line Id | Status | Extended Amount | Sequence Order Line Number |
| Discount Amount | Item Set Type Name | Quantity | Unit Price | Item Class Id | Ship To Party Id |
| Display Order Line Number | Order Id | Sales Team Group Id | Base Price | Item Set Type Code | Tax Schedule Id |
| Is Pledge | Order Line Number | Ship To Full Address Id | Discount Code | Item 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 Object | Relation |
|---|---|
| PartyData | UserData.PartyId = PartyData.PartyId |
| UserData properties: | |||
|---|---|---|---|
| Created On | Is Locked Out | Effective Date | Is Staff |
| Last Activity Date | Expiration Date | Last Login Date | |
| Failed Password Attempt Count | Last Password Changed Date | Is Admin | Party Full Name |
| Is Approved | Party Id | Is Disabled | Username |
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 Object | Relation |
|---|---|
| InvoiceLineData | InvoiceData.InvoiceId = InvoiceLineData.InvoiceId |
| PartyData | InvoiceData.BillToPartyId = PartyData.PartyId OR InvoiceData.SoldToPartyId = PartyData.PartyId OR InvoiceData.ShipToPartyId = PartyData.PartyId |
| FullAddressData | InvoiceData.ShipToAddressId = FullAddress.FullAddressId |
| InvoiceData properties: | |||||||
|---|---|---|---|---|---|---|---|
| Currency Code | Accounting Method | Adjustments Applied | Applied To Invoices | Balance | Base Line Total | Bill To Party Id | Created By |
| Created On | Description | Due Date | Financial Entity Id | Financial Entity Name | Financial Entity Party Id | Handling | Invoice Date |
| Invoice Id | Invoice Number | Invoice Purpose | Invoice Report Type | Invoice Total | Invoice Type Desc | Line Total | Logo Image Description |
| Multiple Installment Payments | Multiple Ship Tos | Order Number | Original Invoice Number | Payment Terms Name | Payments Applied | Pending Payment Adjustment Amount | Price Sheet Name |
| Promo Code | Restocking | Ship Method | Ship To Full Address Id | Ship To Party Id | Shipping | Signature Image Description | Signature Image URL |
| Sold To Party Id | Source Code | Tax Receipt Message | Total Discount | Updated By | Updated On | Weight | |
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 Object | Relation |
|---|---|
| InvoiceData | InvoiceLineData.InvoiceId = InvoiceData.InvoiceId |
| ItemData | InvoiceLineData.ItemId = ItemData.ItemId |
| PartyData | InvoiceLineData.ShipToPartyId = PartyData.PartyId |
| FullAddressData | InvoiceLineData.ShipToAddressId = FullAddressData.FullAddressId |
| InvoiceLineData properties: | |||||
|---|---|---|---|---|---|
| Customer Country Code | Has Child Invoice Lines | Order Line Number | Invoice Id | Invoice Line Id | Parent Invoice Line Number |
| Item Id | Invoice Line Number | Payment Amount Applied | Adjustment Amount Applied | Invoice Number | Quantity |
| Applied to Invoices | Is Event Product | Rate | Balance | Is Event Registration Option | Root Invoice Line Number |
| Base Price | Item Name | Ship To Full Address Id | Exempt Amount | Level | Ship To Party Id |
| Exemption Reason | Line Price Sheet Name | Tax Authority Name | Exemption Registration Number | Line Promo Code | Tax Category Name |
| Extended Amount | Line Ship Method | Unit Price | Extended Base Price | Line Source Code | Uom 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 Object | Relation |
|---|---|
| EventData | FormDefinitionFieldData.FormDefinitionId = EventData.FormDefinitionId OR FormDefinitionFieldData.FormDefinitionSectionId = EventData.FormDefintionSectionId |
| EventFunctionData | FormDefinitionFieldData.FormDefinitionSectionId = EventFunctionData.FormDefinitionSectionId |
| FormFieldResponseData | FormDefinitionFieldData.FormDefinitionFieldId = FormFieldResponseData.FromDefinitionFieldId |
| FormDefinitionFieldData properties: | |
|---|---|
| Form Definition Field Caption | Form Definition Field Id |
| Form Definition Field Sequence | Form Definition Field Type |
| Form Definition Id | Form 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 Object | Relation |
|---|---|
| EventRegistrationData | FormFieldResponoseData.FormResponseId = EventRegistrationData.FormResponseId |
| PartyData | FormFieldResponoseData.PartyId = PartyData.PartyId |
| FormFieldResponseData properties: | |||
|---|---|---|---|
| Field Boolean Value | Form Definition Field Id | Field Date Time Value | Form Response Field Id |
| Field Decimal Value | Form Response Id | Field Integer Value | Party Id |
| Field String Value | Response | Form Definition Field Caption | |
New property names
Here is a list of the new property names with the compatible older properties:
| New Name | Old Name |
|---|---|
| PartyId | ContactKey, UserKey |
| AddressId | AddressKey |
| ItemId | ProductKey |
| ItemClassId | ProductClassKey |
| ItemSaleId | SalesHistoryKey |
| EventId | EventKey |
| EventFunctionId | EventFunctionKey |
| GroupId | GroupKey |
| GroupMemberId | GroupMemberKey |
| GroupMemberDetailId | GroupMemberDetailKey |
| GroupRoleId | GroupRoleKey |
| InvoiceId | InvoiceKey |
| InvoiceLineId | InvoiceLineKey |
| OrderId | OrderKey |
| OrderLineId | OrderLineKey |
Updated about 1 month ago

