Catalyst Fire Ignition Documentation
IHistorical
Represents a single conceptual order between a given individual and netFORUM, including detailed financials not found in IHistoricalOrder.
Definition
Namespace: Ignition.Commerce.Accounting.History
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
C#
public interface IHistoricalOrderWithFinancials : IHistoricalOrderVB
Public Interface IHistoricalOrderWithFinancials
Inherits IHistoricalOrderC++
public interface class IHistoricalOrderWithFinancials : IHistoricalOrderF#
type IHistoricalOrderWithFinancials =
interface
interface IHistoricalOrder
end- Implements
- IHistoricalOrder
Properties
| BenefitingCustomerId |
The same as CustomerId (Inherited from IHistoricalOrder) |
| BillingContactId |
The "Billing Contact" customer for the order, which is the individual that should be contacted for any questions or issues related to billing.
This information is most significant when the BillToCustomerId represents a netFORUM Organization, and this represents a specific Individual in charge of managing billing.
(Inherited from IHistoricalOrder) |
| BillToCustomerId |
The "Bill-To" customer for the order.
The customer responsible for paying for the "benefits" of the order.
(Inherited from IHistoricalOrder) |
| CurrentFinancials | Detailed financial data about this order. |
| CustomerId |
The "Primary" customer for the order.
Can be thought of as the customer who received the "benefits" of the order, be they physical like a book, or conceptual like a membership.
(Inherited from IHistoricalOrder) |
| Date |
The date on which this order began.
Orders may play our over the course of multiple dates (Payment may occur on a different date than Invoicing for example), but this date represents the start of the order.
(Inherited from IHistoricalOrder) |
| Invoices | A collection of all of the invoices generated as a part of this order. NetFORUM does not require all items in an order to be invoiced together, hence why this is a collection and not a single-valued property. NetFORUM also does not require all items to be invoiced at the time of order, so some items in the Items collection may not yet be represented by any invoice in this collection. |
| Items |
A collection of all of the items purchased in this order.
While netFORUM has completely separate means of tracking "OrderDetails" and "InvoiceDetails", this collection centralizes the known information about all of an order's items, regardless of their order/invoice status.
(Inherited from IHistoricalOrder) |
| Number |
A unique number for this order.
NetFORUM's concept of an order "number" is not strictly numeric, and as such is represented as a String.
(Inherited from IHistoricalOrder) |
| OriginalTotal |
The total original cost of this order. Later events such as returns or cancellations mean that the present-day total may no longer match the original total.
To get the most up-to-date information about an order, use CurrentFinancials.
(Inherited from IHistoricalOrder) |
| Payments | A collection of all of the payments made against this order. These payments do not map one-to-one with netFORUM's Payment business object, but instead provide a representation closer to the real world meaning of the word "payment". This collection does not include payments that are considered "internal" to netFORUM such as "write-offs" or (the misleadingly-named) "return payments". |
| Status |
The current status of this order.
NetFORUM does not have a true concept of an order's status, so instead this status represents the "lowest" status of all of the components in this order.
(Inherited from IHistoricalOrder) |