org.kuali.kfs.module.purap.document.dataaccess
Interface PaymentRequestDao

All Known Implementing Classes:

PaymentRequestDaoOjb

public interface PaymentRequestDao

Payment Request DAO Interface.

Method Summary

List<String>	getActivePaymentRequestDocumentNumbersForPurchaseOrder(Integer purchaseOrderId) Retrieves a list of potentially active payment requests for a purchase order by status code.
List	getActivePaymentRequestsByPOIdInvoiceAmountInvoiceDate(Integer poId, org.kuali.rice.kns.util.KualiDecimal invoiceAmount, Date invoiceDate) Retrieves a list of Payment Requests with the given PO Id, invoice amount, and invoice date.
List	getActivePaymentRequestsByVendorNumber(Integer vendorHeaderGeneratedId, Integer vendorDetailAssignedId) Retrieves a list of Payment Requests with the given vendor id and invoice number.
List	getActivePaymentRequestsByVendorNumberInvoiceNumber(Integer vendorHeaderGeneratedId, Integer vendorDetailAssignedId, String invoiceNumber) Retrieves a list of Payment Requests with the given vendor id and invoice number.
String	getDocumentNumberByPaymentRequestId(Integer id) Get a payment request document number by id.
List<String>	getDocumentNumbersByPurchaseOrderId(Integer id) Retrieves a list of document numbers by purchase order id.
List<PaymentRequestDocument>	getEligibleForAutoApproval() Get all payment request documents that are eligible for auto-approval.
Collection<PaymentRequestDocument>	getImmediatePaymentRequestsToExtract(String chartCode) Get all the payment requests that are marked immediate that need to be extracted to PDP.
List<PaymentRequestDocument>	getPaymentRequestInReceivingStatus() Get all payment request which are waiting in receiving status queue
Collection<PaymentRequestDocument>	getPaymentRequestsToExtract(boolean onlySpecialPayments, String chartCode, Date onOrBeforePaymentRequestPayDate) Get all the payment requests that need to be extracted to PDP.
Iterator<PaymentRequestDocument>	getPaymentRequestsToExtract(String campusCode, Integer paymentRequestIdentifier, Integer purchaseOrderIdentifier, Integer vendorHeaderGeneratedIdentifier, Integer vendorDetailAssignedIdentifier) Get all the payment requests that need to be extracted that match a credit memo.
Collection<PaymentRequestDocument>	getPaymentRequestsToExtractForVendor(String campusCode, VendorGroupingHelper vendor, Date onOrBeforePaymentRequestPayDate) Get all the payment requests that need to be extracted that match a credit memo.

Method Detail

getPaymentRequestsToExtract

Iterator<PaymentRequestDocument> getPaymentRequestsToExtract(String campusCode,
                                                             Integer paymentRequestIdentifier,
                                                             Integer purchaseOrderIdentifier,
                                                             Integer vendorHeaderGeneratedIdentifier,
                                                             Integer vendorDetailAssignedIdentifier)

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

Parameters:

campusCode - - limit results to a single chart

paymentRequestIdentifier - - Payment Request Identifier (can be null)

purchaseOrderIdentifier - - PO Identifier (can be null)

vendorHeaderGeneratedIdentifier - - Vendor Header ID

vendorDetailAssignedIdentifier - - Vendor Detail ID

Returns:

- list of payment requests that need to be extracted

getPaymentRequestsToExtractForVendor

Collection<PaymentRequestDocument> getPaymentRequestsToExtractForVendor(String campusCode,
                                                                        VendorGroupingHelper vendor,
                                                                        Date onOrBeforePaymentRequestPayDate)

Get all the payment requests 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

onOrBeforePaymentRequestPayDate - only payment requests with a pay date on or before this value will be returned in the iterator

Returns:

- list of payment requests that need to be extracted

getPaymentRequestsToExtract

Collection<PaymentRequestDocument> getPaymentRequestsToExtract(boolean onlySpecialPayments,
                                                               String chartCode,
                                                               Date onOrBeforePaymentRequestPayDate)

Get all the payment requests 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 payment requests

getImmediatePaymentRequestsToExtract

Collection<PaymentRequestDocument> getImmediatePaymentRequestsToExtract(String chartCode)

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

Parameters:

chartCode - - chart of accounts code

Returns:

- Collection of payment requests

getEligibleForAutoApproval

List<PaymentRequestDocument> getEligibleForAutoApproval()

Get all payment request 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.

Returns:

- an Iterator over all payment request documents eligible for automatic approval

getDocumentNumberByPaymentRequestId

String getDocumentNumberByPaymentRequestId(Integer id)

Get a payment request document number by id.

Parameters:

id - - PaymentRequest Id

Returns:

- PaymentRequest 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

getActivePaymentRequestsByVendorNumberInvoiceNumber

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

Retrieves a list of Payment Requests 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 Payment Requests.

getActivePaymentRequestsByVendorNumber

List getActivePaymentRequestsByVendorNumber(Integer vendorHeaderGeneratedId,
                                            Integer vendorDetailAssignedId)

Retrieves a list of Payment Requests 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 Payment Requests.

getActivePaymentRequestsByPOIdInvoiceAmountInvoiceDate

List getActivePaymentRequestsByPOIdInvoiceAmountInvoiceDate(Integer poId,
                                                            org.kuali.rice.kns.util.KualiDecimal invoiceAmount,
                                                            Date invoiceDate)

Retrieves a list of Payment Requests 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.

getActivePaymentRequestDocumentNumbersForPurchaseOrder

List<String> getActivePaymentRequestDocumentNumbersForPurchaseOrder(Integer purchaseOrderId)

Retrieves a list of potentially active payment requests 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 payment request). Workflow status must be checked further after retrieval.

Parameters:

purchaseOrderId -

Returns:

getPaymentRequestInReceivingStatus

List<PaymentRequestDocument> getPaymentRequestInReceivingStatus()

Get all payment request which are waiting in receiving status queue

Returns: