org.kuali.kfs.module.ar.document.service
Interface PaymentApplicationDocumentService

All Known Implementing Classes:

PaymentApplicationDocumentServiceImpl

public interface PaymentApplicationDocumentService

Method Summary

PaymentApplicationDocument	createAndSavePaymentApplicationToMatchInvoice(CustomerInvoiceDocument customerInvoiceDocument)
InvoicePaidApplied	createInvoicePaidAppliedForInvoiceDetail(CustomerInvoiceDetail customerInvoiceDetail, PaymentApplicationDocument paymentApplicationDocument, Integer paidAppliedItemNumber) This method creates an invoice paid applied for the given customer invoice detail.
PaymentApplicationDocument	createInvoicePaidAppliedsForEntireInvoiceDocument(CustomerInvoiceDocument customerInvoiceDocument, PaymentApplicationDocument paymentApplicationDocument) Creates PaidApplieds for all the invoice lines on the passed in InvoiceDocument, on the passed in PaymentApplicationDocument.
PaymentApplicationDocument	createPaymentApplicationToMatchInvoice(CustomerInvoiceDocument customerInvoiceDocument) This method is used in the lockbox process to create a PA document which is then auto-approved when the amount on the invoice matches the amount on the lockbox.
PaymentApplicationDocument	createSaveAndApprovePaymentApplicationToMatchInvoice(CustomerInvoiceDocument customerInvoiceDocument, String approvalAnnotation, List workflowNotificationRecipients)
boolean	customerInvoiceDetailPairsWithInvoicePaidApplied(CustomerInvoiceDetail customerInvoiceDetail, InvoicePaidApplied invoicePaidApplied) This method returns true if invoicePaidApplied is the applied payment for the customer invoice detail based on document number and item/sequence number.
CashControlDetail	getCashControlDetailForPayAppDocNumber(String payAppDocNumber) Retrieves the CashControlDetail line associated with the passed-in PaymentApplication Document number.
CashControlDetail	getCashControlDetailForPaymentApplicationDocument(PaymentApplicationDocument document) Retrieves the CashControlDetail line associated with the passed-in PaymentApplication Document.
CashControlDocument	getCashControlDocumentForPayAppDocNumber(String payAppDocNumber) Retrieves the CashControlDocument associated with the passed-in PaymentApplication Document number.
CashControlDocument	getCashControlDocumentForPaymentApplicationDocument(PaymentApplicationDocument document) Retrieves the CashControlDocument associated with the passed-in PaymentApplication Document.

Method Detail

getCashControlDetailForPaymentApplicationDocument

CashControlDetail getCashControlDetailForPaymentApplicationDocument(PaymentApplicationDocument document)

Retrieves the CashControlDetail line associated with the passed-in PaymentApplication Document.

Parameters:

document - A valid PaymentApplication Document

Returns:

The associated CashControlDetail, if exists, or null if not.

getCashControlDetailForPayAppDocNumber

CashControlDetail getCashControlDetailForPayAppDocNumber(String payAppDocNumber)

Retrieves the CashControlDetail line associated with the passed-in PaymentApplication Document number.

Parameters:

payAppDocNumber - A valid PaymentApplication Document Number

Returns:

The associated CashControlDetail, if exists, or null if not.

getCashControlDocumentForPaymentApplicationDocument

CashControlDocument getCashControlDocumentForPaymentApplicationDocument(PaymentApplicationDocument document)

Retrieves the CashControlDocument associated with the passed-in PaymentApplication Document.

Parameters:

document - A valid PaymentApplication Document

Returns:

The associated CashControlDocument, if exists, or null if not.

getCashControlDocumentForPayAppDocNumber

CashControlDocument getCashControlDocumentForPayAppDocNumber(String payAppDocNumber)

Retrieves the CashControlDocument associated with the passed-in PaymentApplication Document number.

Parameters:

payAppDocNumber - A valid PaymentApplication Document number

Returns:

The associated CashControlDocument, if exists, or null if not.

createInvoicePaidAppliedsForEntireInvoiceDocument

PaymentApplicationDocument createInvoicePaidAppliedsForEntireInvoiceDocument(CustomerInvoiceDocument customerInvoiceDocument,
                                                                             PaymentApplicationDocument paymentApplicationDocument)

Creates PaidApplieds for all the invoice lines on the passed in InvoiceDocument, on the passed in PaymentApplicationDocument. This method will overwrite any existing PaidApplieds on the document, it assumes an empty PayApp doc with no paidapplieds. This method does no checking to prevent over or under applying, it assumes that the documents have been setup such that it will work correctly. So if this method is used to over or under apply, then the resulting PaymentApplicationDocument will fail business rules validation.

Parameters:

customerInvoiceDocument -

paymentApplicationDocument -

Returns:

createInvoicePaidAppliedForInvoiceDetail

InvoicePaidApplied createInvoicePaidAppliedForInvoiceDetail(CustomerInvoiceDetail customerInvoiceDetail,
                                                            PaymentApplicationDocument paymentApplicationDocument,
                                                            Integer paidAppliedItemNumber)

This method creates an invoice paid applied for the given customer invoice detail. This method assumes that no existing paidApplieds are already on the document.

Parameters:

customerInvoiceDetail - the customer invoice detail for which we want to create the invoice paid applied

applicationDocNbr - the payment application document number

universityFiscalYear - the university fiscal year

universityFiscalPeriodCode - the university fiscal period code

amount - the amount to be applied

Returns:

the created invoice paid applied if it did not exist, null otherwise

createPaymentApplicationToMatchInvoice

PaymentApplicationDocument createPaymentApplicationToMatchInvoice(CustomerInvoiceDocument customerInvoiceDocument)
                                                                  throws org.kuali.rice.kew.exception.WorkflowException

This method is used in the lockbox process to create a PA document which is then auto-approved when the amount on the invoice matches the amount on the lockbox.

Parameters:

customerInvoiceDocument -

Returns:

Throws:

org.kuali.rice.kew.exception.WorkflowException

createSaveAndApprovePaymentApplicationToMatchInvoice

PaymentApplicationDocument createSaveAndApprovePaymentApplicationToMatchInvoice(CustomerInvoiceDocument customerInvoiceDocument,
                                                                                String approvalAnnotation,
                                                                                List workflowNotificationRecipients)
                                                                                throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

createAndSavePaymentApplicationToMatchInvoice

PaymentApplicationDocument createAndSavePaymentApplicationToMatchInvoice(CustomerInvoiceDocument customerInvoiceDocument)
                                                                         throws org.kuali.rice.kew.exception.WorkflowException

Throws:

org.kuali.rice.kew.exception.WorkflowException

customerInvoiceDetailPairsWithInvoicePaidApplied

boolean customerInvoiceDetailPairsWithInvoicePaidApplied(CustomerInvoiceDetail customerInvoiceDetail,
                                                         InvoicePaidApplied invoicePaidApplied)

This method returns true if invoicePaidApplied is the applied payment for the customer invoice detail based on document number and item/sequence number.

Parameters:

customerInvoiceDetail -

invoicePaidApplied -

Returns: