atg.payment.invoicerequest
Interface InvoiceRequestInfo

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GenericInvoiceRequestInfo

public interface InvoiceRequestInfo
extends java.io.Serializable

This interface encapsulates the information required by the invoice request payment method, which is used when a purchase is to be paid for by generating an invoice relative to a customer-supplied purchase order.

In addition to purchase order numbers and billing/delivery information, an InvoiceRequestInfo object includes the order and payment group involved in this payment transaction. This is somewhat different from the behavior of other payment methods, but it is required for proper invoice creation in cases in cases where the order includes multiple payment groups (multiple invoices, combinations of invoices and corporate purchasing cards, etc.)

Generating the line items for the invoice requires knowing which specific commerce items were paid for via this invoice. We can get at that information by traversing the payment group relationships for the order and payment group in the InvoiceRequestInfo object.

Field Summary

static java.lang.String

CLASS_VERSION

Method Summary

java.lang.Double	getBalanceDue() Get the balance due on this invoice.
Address	getBillingAddress() Get the billing address to which this invoice should be sent
Order	getOrder() Get the order being paid for with this invoice
java.lang.Integer	getPaymentDiscountDays() Get the "discount days" component of this invoice's payment terms
java.lang.Double	getPaymentDiscountPercent() Get the "discount percentage" component of this invoice's payment terms
java.util.Date	getPaymentDueDate() Get the date on which payment is nominally due.
PaymentGroup	getPaymentGroup() Get the payment group from which this InvoiceRequestInfo was created
java.lang.Integer	getPaymentNetDays() Get the "net days" component of this invoice's payment terms
java.lang.String	getPONumber() Get the purchase order number associated with this invoice
java.lang.String	getPreferredDeliveryMode() Get the preferred delivery mode (email, postal mail, fax, etc) for this invoice
java.lang.String	getPreferredFormat() Get the preferred delivery format (text, HTML, etc) for this invoice

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Method Detail

getPONumber

java.lang.String getPONumber()

Get the purchase order number associated with this invoice

getBillingAddress

Address getBillingAddress()

Get the billing address to which this invoice should be sent

getOrder

Order getOrder()

Get the order being paid for with this invoice

getPaymentGroup

PaymentGroup getPaymentGroup()

Get the payment group from which this InvoiceRequestInfo was created

getPreferredFormat

java.lang.String getPreferredFormat()

Get the preferred delivery format (text, HTML, etc) for this invoice

getPreferredDeliveryMode

java.lang.String getPreferredDeliveryMode()

Get the preferred delivery mode (email, postal mail, fax, etc) for this invoice

getBalanceDue

java.lang.Double getBalanceDue()

Get the balance due on this invoice.

getPaymentDueDate

java.util.Date getPaymentDueDate()

Get the date on which payment is nominally due.

getPaymentNetDays

java.lang.Integer getPaymentNetDays()

Get the "net days" component of this invoice's payment terms

getPaymentDiscountDays

java.lang.Integer getPaymentDiscountDays()

Get the "discount days" component of this invoice's payment terms

getPaymentDiscountPercent

java.lang.Double getPaymentDiscountPercent()

Get the "discount percentage" component of this invoice's payment terms