com.dpslink.flash.erp

Interface IARInformation

All Superinterfaces:

ERPInterface, java.io.Serializable

All Known Implementing Classes:

ARInformation, ARInformation

public interface IARInformation
extends ERPInterface

Defines the interface for ERP accounts receivable information.

Field Summary

Fields inherited from interface com.dpslink.flash.erp.ERPInterface

ERROR_CONNECT, ERROR_NONE, ERROR_PROGRAM, WARN_DUPLICATE, WARN_NONE

Method Summary

Modifier and Type	Method and Description
boolean	createInvoicePDF(java.lang.String invoiceNumber) Creates an existing invoice as a PDF.
ARSummary	getAR(boolean openInvoices, int daysOfInvoices, int monthsOfAging) Returns accounts receivable information for the current shopping user.
java.lang.String	getErrorCode() Returns the retrieved error code.
java.util.ArrayList<PaymentDetail>	getInvoicePayments(java.lang.String paidbyCustId, java.lang.String invoiceNumber) Returns a collection of payment details for an invoice.
boolean	writeInvoicePDFData(java.io.OutputStream out) Writes the invoice PDF data to the supplied output stream.

Methods inherited from interface com.dpslink.flash.erp.ERPInterface

getContext, getErrorType, getWarningType, setContext, setErrorType, setWarningType

Method Detail

getAR

ARSummary getAR(boolean openInvoices,
                int daysOfInvoices,
                int monthsOfAging)

Returns accounts receivable information for the current shopping user.

Parameters:

openInvoices - (boolean) A flag that designates whether open invoices are retrieved true or all invoices are retrieved false.

daysOfInvoices - (int) Limits the invoices retrieved to this many days in the past.

monthsOfAging - (int) Limits the aging retrieved to this many months in the past.

Returns:

ARSummary - An accounts receivable summary object containing accounts receivable information for the specified user.

getInvoicePayments

java.util.ArrayList<PaymentDetail> getInvoicePayments(java.lang.String paidbyCustId,
                                                      java.lang.String invoiceNumber)

Returns a collection of payment details for an invoice.

Parameters:

paidbyCustId - (String) The paid-by customer for the desired payment details.

invoiceNumber - (String) The invoice number for the desired payment details.

Returns:

ArrayList - The invoice's collection of payment details.

createInvoicePDF

boolean createInvoicePDF(java.lang.String invoiceNumber)

Creates an existing invoice as a PDF.

Parameters:

invoiceNumber - (String) Invoice number.

Returns:

boolean - true if creating the invoice was successful, otherwise false.

writeInvoicePDFData

boolean writeInvoicePDFData(java.io.OutputStream out)

Writes the invoice PDF data to the supplied output stream. A successful call to createInvoicePDF() must be made before executing this method.

Parameters:

out - (OutputStream) The target output stream.

Returns:

boolean - true if operation was successful, otherwise false.

getErrorCode

java.lang.String getErrorCode()

Returns the retrieved error code.

Returns:

String - The error code.