IHistoricalPayment Interface

Represents a payment made against an invoice. Does not map one-to-one with the netFORUM Payment business object, but instead takes a more real-world approach. One IHistoricalPayment contains information about all of the funds of a given type (actual money or preexisting credit) applied to a given invoice.

Definition

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

Properties

AccountingPaymentMethodId For payments made via actual money, the netFORUM Accounting Payment Method that was tied to the payment made.
Amount The amount paid.
AppliedInvoiceId Invoice to which this payment was applied. Will be null if HasBeenAppliedToInvoice is false.
CreditCardCardholderName For payments made via credit card, the credit card's cardholder name; otherwise null.
CreditCardExpirationDate For payments made via credit card, the credit card's expiration date; otherwise null.
CreditCardNumberMasked For payments made via credit card, a safely-masked representation of the credit card's card number; otherwise null.
CustomerId The customer who made this payment.
HasBeenAppliedToInvoice Indicates if this payment has been applied to an invoice.
TransactionCode Transaction code, which can be used to correlate all payments made together, at a single point in time. Will be null if HasBeenAppliedToInvoice is false, as the "transaction" in question represents the application of the payment to an invoice.
TransactionDate The transaction date for this payment. This is not necessarily the date the payment was entered into netFORUM, but is the "official" date of the transaction for accounting purposes. As such, this date may be in the future. Will be null if HasBeenAppliedToInvoice is false, as the "transaction" in question represents the application of the payment to an invoice.
Type The type of funds used to make this payment (basically, actual money or preexisting credit).

See Also