IHistoricalOrderItem Interface

Represents a single item in the context of a IHistoricalOrder.

Definition

Namespace: Ignition.Commerce.Accounting.History
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
C#
public interface IHistoricalOrderItem

Properties

BenefitingCustomerId The customer that effectively receives the benefits of this purchase (such as a physical product, or a membership).
BillToCustomerId The customer that pays for this purchase.
Id Id of this item. This always maps to the Id of a netFORUM InvoiceDetail or OrderDetail, depending on if the item IsInvoiced.
IncomingDistributions A list of the ways in which the value of other items in this order map to this item. See OutgoingDistributions for more information.
IsInvoiced Indicates if this item has been "invoiced", as opposed to only being "ordered" with no invoice generated yet.
ItemName Name of the item being purchased. This maps to the name of this item's netFORUM Price rather than its Product.
OriginalQuantity Original quantity for this IHistoricalOrderItem when it was first entered into this order. Does not take returns or cancels into account.
OriginalTotal Original total cost of this IHistoricalOrderItem when it was first entered into this order, based on OriginalQuantity.
OutgoingDistributions A list of the ways in which this item's value maps to other items in the order. The value represented by distributions is already included in the target item's OriginalTotal and does not need to be accounted for if you do not care about the "behind-the-scenes" mapping between items.
PackageGroupingKey An arbitrary correlator used by netFORUM for grouping together items. Only populated when IsInvoiced is true.
PriceCode Code of the netFORUM Price of the item being purchased.
PriceId netFORUM Price being used for this particular purchase of this ProductId.
PriceName Name of the netFORUM Price being purchased through this item.
ProductId netFORUM Product being purchased through this item.
ProductName Name of the netFORUM Product being purchased through this item.
ProductTypeId Type of the product being purchased.
Status The current status of this item in the context of its IHistoricalOrder.
Type This item's general, high-level type such as Product or Discount. If you're looking for the netFORUM Product Type of the product being purchased, see ProductTypeId.
UnitPrice Unit price for 1 of this item, regardless of the item's actual OriginalQuantity.

See Also