org.kuali.ole.module.purap.document.service

Interface InvoiceService

All Superinterfaces:

AccountsPayableDocumentSpecificService

All Known Subinterfaces:

OleInvoiceService

All Known Implementing Classes:

InvoiceServiceImpl, OleInvoiceServiceImpl

public interface InvoiceService
extends AccountsPayableDocumentSpecificService

Defines methods that must be implemented by a InvoiceService implementation.

Method Summary

Methods

Modifier and Type	Method and Description
InvoiceDocument	addHoldOnInvoice(InvoiceDocument document, String note) Marks a invoice on hold.
boolean	allowBackpost(InvoiceDocument invoiceDocument) Invoices created in the previous fiscal year get backdated if we're at the beginning of the new fiscal year (i.e.
boolean	autoApproveInvoice(InvoiceDocument doc, org.kuali.rice.core.api.util.type.KualiDecimal defaultMinimumLimit) Checks whether the invoice document is eligible for auto approval.
boolean	autoApproveInvoice(String docNumber, org.kuali.rice.core.api.util.type.KualiDecimal defaultMinimumLimit) Checks whether the invoice document is eligible for auto approval.
boolean	autoApproveInvoices() Retrieve a list of PREQs that aren't approved, check to see if they match specific requirements, then auto-approve them if possible.
boolean	autoApprovePaymentRequest(String docNumber) Checks whether the invoice document is eligible for auto approval.
void	calculateInvoice(InvoiceDocument pr, boolean updateDiscount) Recalculate the invoice.
Date	calculatePayDate(Date invoiceDate, PaymentTermType terms) Calculate based on the terms and calculate a date 10 days from today.
void	calculateTaxArea(InvoiceDocument preq) Performs calculations on the tax edit area, generates and adds NRA tax charge items as below the line items, with their accounting lines; the calculation will activate updates on the account summary tab and the general ledger entries as well.
void	cancelExtractedInvoice(InvoiceDocument invoice, String note) Cancels a PREQ that has already been extracted if allowed.
void	changeVendor(InvoiceDocument preq, Integer headerId, Integer detailId) Changes the current vendor to the vendor passed in.
void	clearTax(InvoiceDocument document) Clears tax info.
String	createPreqDocumentDescription(Integer purchaseOrderIdentifier, String vendorName) A method to create the description for the invoice document.
boolean	encumberedItemExistsForInvoicing(PurchaseOrderDocument document)
Collection<InvoiceDocument>	getImmediateInvoicesToExtract(String chartCode) Get all the invoices that are immediate and need to be extracted to PDP.
InvoiceDocument	getInvoiceByDocumentNumber(String documentNumber) Obtains the invoice document given the document number.
InvoiceDocument	getInvoiceById(Integer poDocId) Obtains the invoice document given the purapDocumentIdentifier.
List	getInvoicesByPOIdInvoiceAmountInvoiceDate(Integer poId, org.kuali.rice.core.api.util.type.KualiDecimal invoiceAmount, Date invoiceDate) Obtains a list of invoice documents given the purchase order id, the invoice amount and the invoice date.
List<InvoiceDocument>	getInvoicesByPurchaseOrderId(Integer poDocId) Obtains a list of invoice documents given the purchase order id.
List	getInvoicesByVendorNumber(Integer vendorHeaderGeneratedIdentifier, Integer vendorDetailAssignedIdentifier) Obtains a list of invoice documents given the vendorHeaderGeneratedIdentifier, vendorDetailAssignedIdentifier and the invoice number.
List	getInvoicesByVendorNumberInvoiceNumber(Integer vendorHeaderGeneratedIdentifier, Integer vendorDetailAssignedIdentifier, String invoiceNumber) Obtains a list of invoice documents given the vendorHeaderGeneratedIdentifier, vendorDetailAssignedIdentifier and the invoice number.
Collection<InvoiceDocument>	getInvoicesToExtract(Date onOrBeforeInvoicePayDate) Get all the invoices that need to be extracted.
Collection<InvoiceDocument>	getInvoicesToExtractByCM(String campusCode, VendorCreditMemoDocument cmd) Get all the invoices that match a credit memo.
Collection<InvoiceDocument>	getInvoicesToExtractByVendor(String campusCode, VendorGroupingHelper vendor, Date onOrBeforeInvoicePayDate) Get all the invoices that match a vendor.
Collection<InvoiceDocument>	getInvoicesToExtractSpecialPayments(String chartCode, Date onOrBeforeInvoicePayDate) Get all the special invoices for a single chart that need to be extracted.
Collection<InvoiceDocument>	getInvoiceToExtractByChart(String chartCode, Date onOrBeforeInvoicePayDate) Get all the regular invoices for a single campus.
String	getParameter(String namespaceCode, String componentCode, String parameterName)
boolean	getParameterBoolean(String namespaceCode, String componentCode, String parameterName)
boolean	hasActiveInvoicesForPurchaseOrder(Integer purchaseOrderIdentifier) Determines if there are active invoices for a purchase order.
boolean	hasDiscountItem(InvoiceDocument preq) This method specifies whether the invoice document has a discount item.
HashMap<String,String>	invoiceDuplicateMessages(InvoiceDocument document) Performs the processing to check whether the invoice is a duplicate and if so, adds the information about the type of duplication into the resulting HashMap to be returned by this method.
boolean	isExtracted(InvoiceDocument document) Returns true if the invoice has been extracted
boolean	isInvoiceDateAfterToday(Date invoiceDate) Determines whether the invoice date is after today.
boolean	isPurchaseOrderValidForInvoiceDocumentCreation(InvoiceDocument invoiceDocument, PurchaseOrderDocument po)
void	markPaid(InvoiceDocument pr, Date processDate) Mark a invoice as being paid and set the invoice's paid date as the processDate.
void	populateAndSaveInvoice(InvoiceDocument preq) Populate and save invoice.
void	processInvoiceInReceivingStatus()
InvoiceDocument	removeHoldOnInvoice(InvoiceDocument document, String note) Removes a hold on a invoice.
void	removeIneligibleAdditionalCharges(InvoiceDocument document) Removes additional charge items that are not eligible on the invoice document.
void	removeRequestCancelOnInvoice(InvoiceDocument document, String note) Removes a request cancel on invoice.
void	requestCancelOnInvoice(InvoiceDocument document, String note) Marks a invoice as requested to be canceled.
void	resetExtractedInvoice(InvoiceDocument invoice, String note) Resets a Invoice that had an associated Invoice or Credit Memo cancelled externally.

Methods inherited from interface org.kuali.ole.module.purap.document.service.AccountsPayableDocumentSpecificService

generateGLEntriesCreateAccountsPayableDocument, getPersonForCancel, poItemEligibleForAp, shouldPurchaseOrderBeReversed, takePurchaseOrderCancelAction, updateStatusByNode

Method Detail

getInvoicesByPurchaseOrderId

List<InvoiceDocument> getInvoicesByPurchaseOrderId(Integer poDocId)

Obtains a list of invoice documents given the purchase order id.

Parameters:

poDocId - The purchase order id to be used to obtain a list of invoice documents.

Returns:

The List of invoice documents given the purchase order id.

getInvoicesByPOIdInvoiceAmountInvoiceDate

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

Obtains a list of invoice documents given the purchase order id, the invoice amount and the invoice date.

Parameters:

poId - The purchase order id used to obtain the invoice documents.

invoiceAmount - The invoice amount used to obtain the invoice documents.

invoiceDate - The invoice date used to obtain the invoice documents.

Returns:

The List of invoice documents that match the given criterias (purchase order id, invoice amount and invoice date).

getInvoicesByVendorNumber

List getInvoicesByVendorNumber(Integer vendorHeaderGeneratedIdentifier,
                             Integer vendorDetailAssignedIdentifier)

Obtains a list of invoice documents given the vendorHeaderGeneratedIdentifier, vendorDetailAssignedIdentifier and the invoice number.

Parameters:

vendorHeaderGeneratedIdentifier - The vendorHeaderGeneratedIdentifier used to obtain the invoice documents.

vendorDetailAssignedIdentifier - The vendorDetailAssignedIdentifier used to obtain the invoice documents.

Returns:

The List of invoice documents that match the given criterias.

getInvoicesByVendorNumberInvoiceNumber

List getInvoicesByVendorNumberInvoiceNumber(Integer vendorHeaderGeneratedIdentifier,
                                          Integer vendorDetailAssignedIdentifier,
                                          String invoiceNumber)

Obtains a list of invoice documents given the vendorHeaderGeneratedIdentifier, vendorDetailAssignedIdentifier and the invoice number.

Parameters:

vendorHeaderGeneratedIdentifier - The vendorHeaderGeneratedIdentifier used to obtain the invoice documents.

vendorDetailAssignedIdentifier - The vendorDetailAssignedIdentifier used to obtain the invoice documents.

invoiceNumber - The invoice number used to obtain the invoice documents.

Returns:

The List of invoice documents that match the given criterias.

isInvoiceDateAfterToday

boolean isInvoiceDateAfterToday(Date invoiceDate)

Determines whether the invoice date is after today.

Parameters:

invoiceDate - The invoice date to be determined whether it's after today.

Returns:

boolean true if the given invoice date is after today.

invoiceDuplicateMessages

HashMap<String,String> invoiceDuplicateMessages(InvoiceDocument document)

Performs the processing to check whether the invoice is a duplicate and if so, adds the information about the type of duplication into the resulting HashMap to be returned by this method.

Parameters:

document - The invoice document to be processed/checked for duplicates.

Returns:

The HashMap containing "PREQDuplicateInvoice" as the key and the string describing the types of duplication as the value.

calculatePayDate

Date calculatePayDate(Date invoiceDate,
                    PaymentTermType terms)

Calculate based on the terms and calculate a date 10 days from today. Pick the one that is the farthest out. We always calculate the discount date, if there is one.

Parameters:

invoiceDate - The invoice date to be used in the pay date calculation.

terms - The payment term type to be used in the pay date calculation.

Returns:

The resulting pay date given the invoice date and the terms.

addHoldOnInvoice

InvoiceDocument addHoldOnInvoice(InvoiceDocument document,
                               String note)
                                 throws Exception

Marks a invoice on hold.

Parameters:

document - The invoice document to be marked as on hold.

note - The note to be added to the invoice document while being marked as on hold.

Returns:

The InvoiceDocument with updated information.

Throws:

Exception

removeHoldOnInvoice

InvoiceDocument removeHoldOnInvoice(InvoiceDocument document,
                                  String note)
                                    throws Exception

Removes a hold on a invoice.

Parameters:

document - The invoice document whose hold is to be removed.

note - The note to be added to the invoice document while its hold is being removed.

Returns:

The InvoiceDocument with updated information.

Throws:

Exception

getInvoiceById

InvoiceDocument getInvoiceById(Integer poDocId)

Obtains the invoice document given the purapDocumentIdentifier.

Parameters:

poDocId - The purapDocumentIdentifier of the invoice document to be obtained.

Returns:

The invoice document whose purapDocumentIdentifier matches with the input parameter.

getInvoiceByDocumentNumber

InvoiceDocument getInvoiceByDocumentNumber(String documentNumber)

Obtains the invoice document given the document number.

Parameters:

documentNumber - The document number to be used to obtain the invoice document.

Returns:

The invoice document whose document number matches with the given input parameter.

requestCancelOnInvoice

void requestCancelOnInvoice(InvoiceDocument document,
                          String note)
                            throws Exception

Marks a invoice as requested to be canceled.

Parameters:

document - The invoice document to be marked as requested to be canceled.

note - The note to be added to the invoice document while being marked as requested to be canceled.

Throws:

Exception

isExtracted

boolean isExtracted(InvoiceDocument document)

Returns true if the invoice has been extracted

Parameters:

document - The invoice document to be determined whether it is extracted.

Returns:

boolean true if the invoice document is extracted.

removeRequestCancelOnInvoice

void removeRequestCancelOnInvoice(InvoiceDocument document,
                                String note)
                                  throws Exception

Removes a request cancel on invoice.

Parameters:

document - The invoice document to be used for request cancel.

note - The note to be added to the invoice document upon the removal of the request cancel.

Throws:

Exception

resetExtractedInvoice

void resetExtractedInvoice(InvoiceDocument invoice,
                         String note)

Resets a Invoice that had an associated Invoice or Credit Memo cancelled externally.

Parameters:

invoice - The extracted invoice document to be resetted.

note - The note to be added to the invoice document upon its reset.

cancelExtractedInvoice

void cancelExtractedInvoice(InvoiceDocument invoice,
                          String note)

Cancels a PREQ that has already been extracted if allowed.

Parameters:

invoice - The extracted invoice document to be canceled.

note - The note to be added to the invoice document.

getImmediateInvoicesToExtract

Collection<InvoiceDocument> getImmediateInvoicesToExtract(String chartCode)

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

Parameters:

chartCode - The chart code to be used as one of the criterias to retrieve the invoice documents.

Returns:

The iterator of the list of the resulting invoice documents returned by the invoiceDao.

getInvoicesToExtractByCM

Collection<InvoiceDocument> getInvoicesToExtractByCM(String campusCode,
                                                   VendorCreditMemoDocument cmd)

Get all the invoices that match a credit memo.

Parameters:

cmd - The credit memo document to be used to obtain the invoices.

Returns:

The iterator of the resulting invoice documents returned by the invoiceDao.

getInvoicesToExtractByVendor

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

Get all the invoices that match a vendor.

Parameters:

vendor -

onOrBeforeInvoicePayDate - only invoices with a pay date on or before this date will be extracted

Returns:

Collection of the resulting invoice documents returned by the invoiceDao.

getInvoicesToExtract

Collection<InvoiceDocument> getInvoicesToExtract(Date onOrBeforeInvoicePayDate)

Get all the invoices that need to be extracted.

Returns:

The Collection of the resulting invoice documents returned by the invoiceDao.

getInvoicesToExtractSpecialPayments

Collection<InvoiceDocument> getInvoicesToExtractSpecialPayments(String chartCode,
                                                              Date onOrBeforeInvoicePayDate)

Get all the special invoices for a single chart that need to be extracted.

Parameters:

chartCode - The chart code to be used as one of the criterias to retrieve the invoice documents.

Returns:

The Collection of the resulting invoice documents returned by the invoiceDao.

getInvoiceToExtractByChart

Collection<InvoiceDocument> getInvoiceToExtractByChart(String chartCode,
                                                     Date onOrBeforeInvoicePayDate)

Get all the regular invoices for a single campus.

Parameters:

chartCode - The chart code to be used as one of the criterias to retrieve the invoice documents.

Returns:

The collection of the resulting invoice documents returned by the invoiceDao.

calculateInvoice

void calculateInvoice(InvoiceDocument pr,
                    boolean updateDiscount)

Recalculate the invoice.

Parameters:

pr - The invoice document to be calculated.

updateDiscount - boolean true if we also want to calculate the discount items for the invoice.

calculateTaxArea

void calculateTaxArea(InvoiceDocument preq)

Performs calculations on the tax edit area, generates and adds NRA tax charge items as below the line items, with their accounting lines; the calculation will activate updates on the account summary tab and the general ledger entries as well.

The non-resident alien (NRA) tax lines consist of four possible sets of tax lines: - Federal tax lines - Federal Gross up tax lines - State tax lines - State Gross up tax lines

Federal tax lines are generated if the federal tax rate in the invoice is not zero. State tax lines are generated if the state tax rate in the invoice is not zero. Gross up tax lines are generated if the tax gross up indicator is set on the invoice and the tax rate is not zero.

Parameters:

preq - The invoice the NRA tax lines will be added to.

populateAndSaveInvoice

void populateAndSaveInvoice(InvoiceDocument preq)
                            throws org.kuali.rice.kew.api.exception.WorkflowException

Populate and save invoice.

Parameters:

preq - The invoice document to be populated and saved.

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

autoApproveInvoices

boolean autoApproveInvoices()

Retrieve a list of PREQs that aren't approved, check to see if they match specific requirements, then auto-approve them if possible.

Returns:

boolean true if the auto approval of invoices has at least one error.

autoApproveInvoice

boolean autoApproveInvoice(String docNumber,
                         org.kuali.rice.core.api.util.type.KualiDecimal defaultMinimumLimit)

Checks whether the invoice document is eligible for auto approval. If so, then updates the status of the document to auto approved and calls the documentService to blanket approve the document, then returns false. If the document is not eligible for auto approval then returns true.

Parameters:

docNumber - The invoice document number (not the invoice ID) to be auto approved.

defaultMinimumLimit - The default minimum limit amount to be used in determining the eligibility of the document to be auto approved.

Returns:

boolean true if the invoice document is not eligible for auto approval.

Throws:

RuntimeException - To indicate to Spring transactional management that the transaction for this document should be rolled back

autoApproveInvoice

boolean autoApproveInvoice(InvoiceDocument doc,
                         org.kuali.rice.core.api.util.type.KualiDecimal defaultMinimumLimit)

Checks whether the invoice document is eligible for auto approval. If so, then updates the status of the document to auto approved and calls the documentService to blanket approve the document, then returns false. If the document is not eligible for auto approval then returns true.

Parameters:

doc - The invoice document to be auto approved.

defaultMinimumLimit - The default minimum limit amount to be used in determining the eligibility of the document to be auto approved.

Returns:

boolean true if the invoice document is not eligible for auto approval.

Throws:

RuntimeException - To indicate to Spring transactional management that the transaction for this document should be rolled back

markPaid

void markPaid(InvoiceDocument pr,
            Date processDate)

Mark a invoice as being paid and set the invoice's paid date as the processDate.

Parameters:

pr - The invoice document to be marked as paid and paid date to be set.

processDate - The date to be set as the invoice's paid date.

hasDiscountItem

boolean hasDiscountItem(InvoiceDocument preq)

This method specifies whether the invoice document has a discount item.

Parameters:

preq - The invoice document to be verified whether it has a discount item.

Returns:

boolean true if the invoice document has at least one discount item.

changeVendor

void changeVendor(InvoiceDocument preq,
                Integer headerId,
                Integer detailId)

Changes the current vendor to the vendor passed in.

Parameters:

preq -

headerId -

detailId -

createPreqDocumentDescription

String createPreqDocumentDescription(Integer purchaseOrderIdentifier,
                                   String vendorName)

A method to create the description for the invoice document.

Parameters:

purchaseOrderIdentifier - The purchase order identifier to be used as part of the description.

vendorName - The vendor name to be used as part of the description.

Returns:

The resulting description string for the invoice document.

hasActiveInvoicesForPurchaseOrder

boolean hasActiveInvoicesForPurchaseOrder(Integer purchaseOrderIdentifier)

Determines if there are active invoices for a purchase order.

Parameters:

purchaseOrderIdentifier -

Returns:

processInvoiceInReceivingStatus

void processInvoiceInReceivingStatus()

allowBackpost

boolean allowBackpost(InvoiceDocument invoiceDocument)

Invoices created in the previous fiscal year get backdated if we're at the beginning of the new fiscal year (i.e. prior to first closing)

Parameters:

invoiceDocument -

Returns:

isPurchaseOrderValidForInvoiceDocumentCreation

boolean isPurchaseOrderValidForInvoiceDocumentCreation(InvoiceDocument invoiceDocument,
                                                     PurchaseOrderDocument po)

removeIneligibleAdditionalCharges

void removeIneligibleAdditionalCharges(InvoiceDocument document)

Removes additional charge items that are not eligible on the invoice document.

Parameters:

document -

encumberedItemExistsForInvoicing

boolean encumberedItemExistsForInvoicing(PurchaseOrderDocument document)

clearTax

void clearTax(InvoiceDocument document)

Clears tax info.

Parameters:

document - The disbursement voucher document being modified.

autoApprovePaymentRequest

boolean autoApprovePaymentRequest(String docNumber)

Checks whether the invoice document is eligible for auto approval. If so, then updates the status of the document to auto approved and calls the documentService to blanket approve the document, then returns false. If the document is not eligible for auto approval then returns true.

Parameters:

docNumber - The invoice document number (not the invoice ID) to be auto approved.

Returns:

boolean true if the invoice document is not eligible for auto approval.

Throws:

RuntimeException - To indicate to Spring transactional management that the transaction for this document should be rolled back

getParameter

String getParameter(String namespaceCode,
                  String componentCode,
                  String parameterName)

getParameterBoolean

boolean getParameterBoolean(String namespaceCode,
                          String componentCode,
                          String parameterName)