org.kuali.ole.module.purap.document.dataaccess

Interface InvoiceDao

All Known Implementing Classes:

InvoiceDaoOjb

public interface InvoiceDao

Invoice DAO Interface.

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getActiveInvoiceDocumentNumbersForPurchaseOrder(Integer purchaseOrderId) Retrieves a list of potentially active invoices for a purchase order by status code.
List	getActiveInvoicesByPOIdInvoiceAmountInvoiceDate(Integer poId, org.kuali.rice.core.api.util.type.KualiDecimal invoiceAmount, Date invoiceDate) Retrieves a list of Invoices with the given PO Id, invoice amount, and invoice date.
List	getActiveInvoicesByVendorNumber(Integer vendorHeaderGeneratedId, Integer vendorDetailAssignedId) Retrieves a list of Invoices with the given vendor id and invoice number.
List	getActiveInvoicesByVendorNumberInvoiceNumber(Integer vendorHeaderGeneratedId, Integer vendorDetailAssignedId, String invoiceNumber) Retrieves a list of Invoices with the given vendor id and invoice number.
String	getDocumentNumberByInvoiceId(Integer id) Get a invoice document number by id.
List<String>	getDocumentNumbersByPurchaseOrderId(Integer id) Retrieves a list of document numbers by purchase order id.
List<String>	getEligibleForAutoApproval(Date todayAtMidnight) Get all invoice documents that are eligible for auto-approval.
List<InvoiceDocument>	getImmediateInvoicesToExtract(String chartCode) Get all the invoices that are marked immediate that need to be extracted to PDP.
List<String>	getInvoiceInReceivingStatus() Get all invoice which are waiting in receiving status queue
List<InvoiceDocument>	getInvoicesToExtract(boolean onlySpecialPayments, String chartCode, Date onOrBeforeInvoicePayDate) Get all the invoices that need to be extracted to PDP.
List<InvoiceDocument>	getInvoicesToExtract(String campusCode, Integer invoiceIdentifier, Integer purchaseOrderIdentifier, Integer vendorHeaderGeneratedIdentifier, Integer vendorDetailAssignedIdentifier, Date currentSqlDateMidnight) Get all the invoices that need to be extracted that match a credit memo.
Collection<InvoiceDocument>	getInvoicesToExtractForVendor(String campusCode, VendorGroupingHelper vendor, Date onOrBeforeInvoicePayDate) Get all the invoices that need to be extracted that match a credit memo.

Method Detail

getInvoicesToExtract

List<InvoiceDocument> getInvoicesToExtract(String campusCode,
                                         Integer invoiceIdentifier,
                                         Integer purchaseOrderIdentifier,
                                         Integer vendorHeaderGeneratedIdentifier,
                                         Integer vendorDetailAssignedIdentifier,
                                         Date currentSqlDateMidnight)

Get all the invoices that need to be extracted that match a credit memo.

Parameters:

campusCode - - limit results to a single chart

invoiceIdentifier - - Invoice Identifier (can be null)

purchaseOrderIdentifier - - PO Identifier (can be null)

vendorHeaderGeneratedIdentifier - - Vendor Header ID

vendorDetailAssignedIdentifier - - Vendor Detail ID

currentSqlDateMidnight - current SQL date midnight

Returns:

- list of invoices that need to be extracted

getInvoicesToExtractForVendor

Collection<InvoiceDocument> getInvoicesToExtractForVendor(String campusCode,
                                                        VendorGroupingHelper vendor,
                                                        Date onOrBeforeInvoicePayDate)

Get all the invoices that need to be extracted that match a credit memo.

Parameters:

campusCode - - limit results to a single chart

vendor - - Vendor Header ID, Vendor Detail ID, Country, Zip Code

onOrBeforeInvoicePayDate - only invoices with a pay date on or before this value will be returned in the iterator

Returns:

- list of invoices that need to be extracted

getInvoicesToExtract

List<InvoiceDocument> getInvoicesToExtract(boolean onlySpecialPayments,
                                         String chartCode,
                                         Date onOrBeforeInvoicePayDate)

Get all the invoices that need to be extracted to PDP.

Parameters:

onlySpecialPayments - - true only include special payments, False - include all

chartCode - - if not null, limit results to a single chart

Returns:

- Collection of invoices

getImmediateInvoicesToExtract

List<InvoiceDocument> getImmediateInvoicesToExtract(String chartCode)

Get all the invoices that are marked immediate that need to be extracted to PDP.

Parameters:

chartCode - - chart of accounts code

Returns:

- Collection of invoices

getEligibleForAutoApproval

List<String> getEligibleForAutoApproval(Date todayAtMidnight)

Get all invoice documents that are eligible for auto-approval. Whether or not a document is eligible for auto-approval is determined according to whether or not the document total is below a pre-determined minimum amount. This amount is derived from the accounts, charts and/or organizations associated with a given document. If no minimum amount can be determined from chart associations a default minimum specified as a system parameter is used to determine the minimum amount threshold.

Parameters:

todayAtMidnight -

Returns:

- an Iterator over all invoice documents eligible for automatic approval

getDocumentNumberByInvoiceId

String getDocumentNumberByInvoiceId(Integer id)

Get a invoice document number by id.

Parameters:

id - - Invoice Id

Returns:

- Invoice or null if not found

getDocumentNumbersByPurchaseOrderId

List<String> getDocumentNumbersByPurchaseOrderId(Integer id)

Retrieves a list of document numbers by purchase order id.

Parameters:

id - - purchase order id

Returns:

- list of document numbers

getActiveInvoicesByVendorNumberInvoiceNumber

List getActiveInvoicesByVendorNumberInvoiceNumber(Integer vendorHeaderGeneratedId,
                                                Integer vendorDetailAssignedId,
                                                String invoiceNumber)

Retrieves a list of Invoices with the given vendor id and invoice number.

Parameters:

vendorHeaderGeneratedId - - header id of the vendor id

vendorDetailAssignedId - - detail id of the vendor id

invoiceNumber - - invoice number as entered by AP

Returns:

- List of Invoices.

getActiveInvoicesByVendorNumber

List getActiveInvoicesByVendorNumber(Integer vendorHeaderGeneratedId,
                                   Integer vendorDetailAssignedId)

Retrieves a list of Invoices with the given vendor id and invoice number.

Parameters:

vendorHeaderGeneratedId - - header id of the vendor id

vendorDetailAssignedId - - detail id of the vendor id

Returns:

- List of Invoices.

getActiveInvoicesByPOIdInvoiceAmountInvoiceDate

List getActiveInvoicesByPOIdInvoiceAmountInvoiceDate(Integer poId,
                                                   org.kuali.rice.core.api.util.type.KualiDecimal invoiceAmount,
                                                   Date invoiceDate)

Retrieves a list of Invoices with the given PO Id, invoice amount, and invoice date.

Parameters:

poId - - purchase order ID

invoiceAmount - - amount of the invoice as entered by AP

invoiceDate - - date of the invoice as entered by AP

Returns:

- List of Pay Reqs.

getActiveInvoiceDocumentNumbersForPurchaseOrder

List<String> getActiveInvoiceDocumentNumbersForPurchaseOrder(Integer purchaseOrderId)

Retrieves a list of potentially active invoices for a purchase order by status code. Active being defined as being enroute and before final. The issue is that a status of vendor_tax_review may not mean that it's in review, but could be in final (as there isn't a final status code for invoice). Workflow status must be checked further after retrieval.

Parameters:

purchaseOrderId -

Returns:

getInvoiceInReceivingStatus

List<String> getInvoiceInReceivingStatus()

Get all invoice which are waiting in receiving status queue

Returns: