Click or drag to resize

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.

Namespace: Ignition.Commerce.Accounting.History
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.28229
Syntax
Copy
public interface IHistoricalPayment

The IHistoricalPayment type exposes the following members.

Properties
 NameDescription
Public propertyAccountingPaymentMethodId For payments made via actual money, the netFORUM Accounting Payment Method that was tied to the payment made.
Public propertyAmount The amount paid.
Public propertyAppliedInvoiceId Invoice to which this payment was applied. Will be null if HasBeenAppliedToInvoice is false.
Public propertyCreditCardCardholderName For payments made via credit card, the credit card's cardholder name; otherwise null.
Public propertyCreditCardExpirationDate For payments made via credit card, the credit card's expiration date; otherwise null.
Public propertyCreditCardNumberMasked For payments made via credit card, a safely-masked representation of the credit card's card number; otherwise null.
Public propertyCustomerId The customer who made this payment.
Public propertyHasBeenAppliedToInvoice Indicates if this payment has been applied to an invoice.
Public propertyTransactionCode 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.
Public propertyTransactionDate 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.
Public propertyType The type of funds used to make this payment (basically, actual money or preexisting credit).
Top
See Also