Commerce Business Objects
The following Commerce business objects are commonly used in commerce-related queries. Review the descriptions to see how each can be joined with other business objects and what properties they include.
CsOrderHistory
Contains product order history information. There are likely multiple rows per iMIS ID in this BO, one row for each order. Order history is only generated after order payments and batches have been processed.
Common joins
Some common joins include:
Table 60: Viewing common joins for CsOrderHistory
| Business Object | Relation | Notes |
|---|---|---|
| NetContactData | CsOrderHistory.ID = NetContactData.Id | Gets details about a specific order. Filter on product code to see specific product details of an order. |
Properties
Table 61: Viewing properties for CsOrderHistory
| Properties |
|---|
| ActivityType |
| Amount |
| CompanyId |
| ProductName |
| ID |
| MemberType |
| ProductCode |
| Quantity |
| SequenceNumber |
| SourceCode |
| TransactionDate |
CsOrderLines
Stores data on the line items of open and closed orders. Includes 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:
Table 62: Viewing common joins for CsOrderHistory
| Business Object | Relation |
|---|---|
| CsProduct | CsOrderLine.Product Code = CsProduct.Product Code |
| CsOrders | CsOrder.Order Number = CsOrderLine.Order Number |
| CsFunction | CsOrderLines.Product Code = CsFunction.Product Code |
Properties
Table 63: Viewing properties for CsOrderHistory
| Properties | |||
|---|---|---|---|
| Description | LineNumber | QuantityCommitted | UnitCost |
| Discount | Location | QuantityOrdered | UnitPrice |
| ExtendedAmount | Note | QuantityReserved | VATTaxAuthority |
| ExtendedCost | OrderNumber | QuantityShipped | VATTaxRate |
| GSTTaxable | ProductCode | Tax1 | DiscountCode |
| IncomeAccount | QuantityBackordered | Taxable |
CsOrders
Contains order level details. CsOrders is commonly used to create an invoice or receipt, view order details (amounts paid or outstanding balances), and details on promotion codes.
Common joins
Some common joins include:
Table 64: Viewing common joins for CsOrders
| Business Object | Relation | Notes |
|---|---|---|
| NetContactData | CsOrders.ST\_ID = NetContactData.Id | Gets contact details about a specific ID. ST\_ID represents the Ship To ID. |
| CsOrders.BT\_ID = NetContactData.Id | Gets contact details about a specific billing ID. BT\_ID represents the Bill To ID. |
Properties
Table 65: Viewing properties for CsOrders
| Properties | |||
|---|---|---|---|
| Address1 | CustomerReference | Notes | Tax2 |
| Address2 | OrderDate | Tax3 | |
| Address3 | Freight1 | OrderNumber | TaxRate1 |
| AddressFormat | Freight2 | OrderTypeCode | TaxRate2 |
| Balance | FullAddress | EntityCode | TaxRate3 |
| BatchNumber | FullName | PayType | Title |
| BillToId | Handling1 | Phone | TotalCharges |
| City | Handling2 | SourceCode | TotalPayments |
| CompanyId | HoldCode | ShipToId | TotalQuantityBackordered |
| CompanyMemberType | HoldComment | Stage | TotalQuantityOrdered |
| Company | HoldFlag | StateProvince | Zip |
| CompanySort | InvoiceReferenceNumber | Status | Source\_System |
| Country | MemberType | Tax1 | Discount\_Code |
CsProduct
Contains information about products in iMIS, including dues, certifications, meetings, chapters, committees, and more.
Product contains varying types of products. ProductCode is a concatenation of the type of product and the individual product code in order to create a unique identifier for each row (e.g. COMMITTEE/BOARD). Use product minor for the specific item’s code (e.g. BOARD) but be aware if you have other products that use that code you may get inaccurate results.
Common joins
Some common joins include:
Table 66: Viewing common joins for CsProduct
| Business Object | Relation |
|---|---|
| CsOrderLines | CsProduct.ProductCode = CsOrderLines.ProductCode |
Properties
Viewing 67: Viewing properties for CsProduct
| Properties | ||
|---|---|---|
| Apply\_Image | ProductCode | PublishStartDate |
| Apply\_Thumbnail | ProductMajor | RelatedContentMessage |
| DeferredIncomeAccount | ProductMinor | FairMarketValue |
| Description | ProductType | Is\_Kit |
| Image\_URL | SellOnWeb | Is\_Premium |
| IncomeAccount | Status | MinimumGiftAmount |
| IsFeatured | Thumbnail\_URL | Price\_From\_Components |
| IsSuperProduct | Title | IsFundraisingItem |
| Price1 | TitleKey | IsStockItem |
| Price2 | Web\_Desc | AllowOrderLineNote |
| Price3 | Web\_Option | OrgCode |
| ProductCategory | PublishEndDate |
CsProductCategory
Contains the product categories (Settings > Commerce > Product categories) for products created at Commerce > Add product.
Common joins
Some common joins include:
Table 68: Viewing common joins for CsProductCategory
| Business Object | Relation |
|---|---|
| CsProduct | CsProductCategory.ProductCategory = CsProduct.ProductCategory |
Properties
Table 69: Viewing properties for CsProductCategory
| Properties |
|---|
| Description |
| ProductCategory |
| UserDefinedField1 |
| UserDefinedField2 |
| UserDefinedField3 |
| UserDefinedField4 |
CsProductType
Contains Product Types for items in the Product table.
Common joins
Some common joins include:
Table 70: Viewing common joins for CsProductType
| Business Object | Relation |
|---|---|
| CsProduct | CsProductType.ProductType = CsProduct.ProductType |
Properties
Table 71: Viewing properties for CsProductType
| Properties |
|---|
| ProductType |
| Description |
CommerceProduct
Stores data on commerce-specific products. Includes fair market value, shipping and handling charges, weight, standard price, discounted price, and other commerce data.
Properties
Table 72: Viewing properties for CommerceProduct
| Properties | |||
|---|---|---|---|
| AdjustmentAccount | IncursShippingCharge | ProductKey | UpdatedOn |
| AllowOrderLineNotice | InventoryAccount | PublishEndDate | Description |
| COGAccount | InventoryNotAvailableMessage | PublishStartDate | WebOption |
| DefferedIncomeAmount | IsCollection | PostPurchaseInformation | Weight |
| FairMarketValue | MinimumGiftAmount | Status | Category |
| ImageURL | OrgCode | InventoryItem | Standard Price |
| ImageDescription | Premium | TaxAuthority | DiscountPrice |
| IncomeAccount | PriceFromComponents | TaxByLocation | AvailableInSearch |
| IncursHandlingCharge | ProductCode | Title |
OrdersWithPromotions
Displays all orders and invoices where promotions were applied at checkout.
NoteMembership promotions do not have an order number, and orders which have not yet been invoiced do not have values for invoice properties.
Common joins
Some common joins include:
Table 73: Viewing common joins for OrdersWithPromotions
| Business Object | Relation |
|---|---|
| CsOrders | CsOrders.Order Number = OrdersWithPromotions.Order\_Number |
| InvoiceSummary | OrdersWithPromotions.Invoice Id = InvoiceSummary.Invoice ID |
Properties
Table 74: Viewing properties for OrdersWithPromotions
| Properties | |||
|---|---|---|---|
| FULL\_NAME | BT\_ID | ORDER\_DATE | OrderPromotionName |
| DISCOUNT\_CODE | UNDISCOUNTED\_TOTAL | LINE\_TOTAL | ORDER\_NUMBER |
| DiscountAmount | ORDER\_TYPE\_CODE | SOURCE\_SYSTEM | InvoiceID |
| InvoiceNumber | InvoiceReferenceNumber | TotalCharges |
PromotionUsageByItem
Contains line items from orders and invoices where a promotion was applied.
NoteMembership promotions do not have an order number, and orders which have not yet been invoiced do not have values for invoice properties.
Common joins
Some common joins include:
Table 75: Viewing common joins for PromotionUsageByItem
| Business Object | Relation |
|---|---|
| CsOrders | PromotionUsageByItem.Invoice Number = CsOrders.Invoice Number |
| InvoiceSummary | InvoiceSummary PromotionUsageByItem.InvoiceId = InvoiceSummary.Invoice ID |
Properties
Table 76: Viewing properties for PromotionUsageByItem
| Properties | |||
|---|---|---|---|
| Amount | BillToPartyId | DiscountAmount | EventName |
| InvoiceId | InvoiceNumber | InvoiceReferenceNumber | ItemId |
| ItemName | ItemPromotionCode | ItemPromotionName | LineNumber |
| OrderNumber | OrderPromotionCode | OrderPromotionName | OrderUndiscountedTotal |
| SourceSystem | TransactionDate | UndiscountedAmount | |
NoteThe following properties contain order or invoice level information, which comes from the parent order or invoice instead of single line items:
- OrderPromotionName
- OrderPromotionCode
- OrderUndiscountedTotal
- Total Charges
The following properties contain single line-item information:
- ItemId
- ItemName
- ItemPromotionCode
- ItemPromotionName
- LineNumber
