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

All Known Implementing Classes:

CustomerInvoiceWriteoffDocumentServiceImpl

public interface CustomerInvoiceWriteoffDocumentService

Method Summary

boolean	checkIfThereIsNoAnotherCRMInRouteForTheInvoice(String invoiceDocumentNumber) This method checks if there is no another CRM in route for the invoice Not in route if CRM status is one of the following: processed, cancelled, or disapproved
boolean	checkIfThereIsNoAnotherWriteoffInRouteForTheInvoice(String invoiceDocumentNumber) This method checks if there is no another writeoff in route for the invoice Not in route if writeoff status is one of the following: processed, cancelled, or disapproved
void	completeWriteoffProcess(CustomerInvoiceWriteoffDocument writeoff) Finalizes the actions of a Writeoff document, once its been completely approved.
String	createCustomerInvoiceWriteoffDocument(org.kuali.rice.kim.bo.Person initiator, String invoiceNumber, String note) Creates a new Invoice Writeoff Document based on the indicated Invoice doc number and the initiator.
Collection<CustomerInvoiceDocument>	filterInvoices(Collection<CustomerInvoiceDocument> customerInvoiceDocuments) This method filters invoices which have related CRMs and/or writeoffs in route
Collection<CustomerInvoiceWriteoffLookupResult>	getCustomerInvoiceDocumentsForInvoiceWriteoffLookup(Map<String,String> fieldValues) This method returns a collection of customer invoice documents that are eligible for writeoff
String	getFinancialObjectCode(CustomerInvoiceDetail postable, CustomerInvoiceWriteoffDocument poster, boolean isUsingOrgAcctDefaultWriteoffFAU, boolean isUsingChartForWriteoff, String chartOfAccountsCode)
ObjectCode	getObjectCode(CustomerInvoiceDetail postable, CustomerInvoiceWriteoffDocument poster, boolean isUsingOrgAcctDefaultWriteoffFAU, boolean isUsingChartForWriteoff, String chartOfAccountsCode)
boolean	isCustomerInvoiceWriteoffDocumentApproved(String customerInvoiceWriteoffDocumentNumber) This method returns true if a customer invoice writeoff document is approved
String	sendCustomerInvoiceWriteoffDocumentsToBatch(org.kuali.rice.kim.bo.Person person, Collection<CustomerInvoiceWriteoffLookupResult> customerInvoiceWriteoffLookupResults) Accepts a lookup result and creates a batch file dropped into the batch system for later asynchronous processing.
void	setupDefaultValuesForNewCustomerInvoiceWriteoffDocument(CustomerInvoiceWriteoffDocument customerInvoiceWriteoffDocument) This method setups any default values for a new customer invoice document

Method Detail

completeWriteoffProcess

void completeWriteoffProcess(CustomerInvoiceWriteoffDocument writeoff)

Finalizes the actions of a Writeoff document, once its been completely approved. Generates paid applieds for the source invoice, and closes the source invoice.

Parameters:

writeoff - The approved Writeoff document to complete.

setupDefaultValuesForNewCustomerInvoiceWriteoffDocument

void setupDefaultValuesForNewCustomerInvoiceWriteoffDocument(CustomerInvoiceWriteoffDocument customerInvoiceWriteoffDocument)

This method setups any default values for a new customer invoice document

Parameters:

customerInvoiceWriteoffDocument -

isCustomerInvoiceWriteoffDocumentApproved

boolean isCustomerInvoiceWriteoffDocumentApproved(String customerInvoiceWriteoffDocumentNumber)

This method returns true if a customer invoice writeoff document is approved

Parameters:

customerInvoiceWriteoffDocumentNumber -

Returns:

getCustomerInvoiceDocumentsForInvoiceWriteoffLookup

Collection<CustomerInvoiceWriteoffLookupResult> getCustomerInvoiceDocumentsForInvoiceWriteoffLookup(Map<String,String> fieldValues)

This method returns a collection of customer invoice documents that are eligible for writeoff

Parameters:

fieldValues -

Returns:

filterInvoices

Collection<CustomerInvoiceDocument> filterInvoices(Collection<CustomerInvoiceDocument> customerInvoiceDocuments)

This method filters invoices which have related CRMs and/or writeoffs in route

Parameters:

customerInvoiceDocuments -

Returns:

filteredInvoices

checkIfThereIsNoAnotherCRMInRouteForTheInvoice

boolean checkIfThereIsNoAnotherCRMInRouteForTheInvoice(String invoiceDocumentNumber)

This method checks if there is no another CRM in route for the invoice Not in route if CRM status is one of the following: processed, cancelled, or disapproved

Parameters:

invoice -

Returns:

checkIfThereIsNoAnotherWriteoffInRouteForTheInvoice

boolean checkIfThereIsNoAnotherWriteoffInRouteForTheInvoice(String invoiceDocumentNumber)

This method checks if there is no another writeoff in route for the invoice Not in route if writeoff status is one of the following: processed, cancelled, or disapproved

Parameters:

invoice -

Returns:

sendCustomerInvoiceWriteoffDocumentsToBatch

String sendCustomerInvoiceWriteoffDocumentsToBatch(org.kuali.rice.kim.bo.Person person,
                                                   Collection<CustomerInvoiceWriteoffLookupResult> customerInvoiceWriteoffLookupResults)

Accepts a lookup result and creates a batch file dropped into the batch system for later asynchronous processing.

Parameters:

personId -

customerInvoiceWriteoffLookupResults -

Returns:

filename and path of created batch file

createCustomerInvoiceWriteoffDocument

String createCustomerInvoiceWriteoffDocument(org.kuali.rice.kim.bo.Person initiator,
                                             String invoiceNumber,
                                             String note)
                                             throws org.kuali.rice.kew.exception.WorkflowException

Creates a new Invoice Writeoff Document based on the indicated Invoice doc number and the initiator.

Parameters:

initiator - Person who initiated the writeoffs.

invoiceNumber - Invoice document number to base the writeoff on.

note - User note to be added to the document.

Returns:

Returns the Document Number of the Invoice Writeoff document created.

Throws:

org.kuali.rice.kew.exception.WorkflowException

getFinancialObjectCode

String getFinancialObjectCode(CustomerInvoiceDetail postable,
                              CustomerInvoiceWriteoffDocument poster,
                              boolean isUsingOrgAcctDefaultWriteoffFAU,
                              boolean isUsingChartForWriteoff,
                              String chartOfAccountsCode)

getObjectCode

ObjectCode getObjectCode(CustomerInvoiceDetail postable,
                         CustomerInvoiceWriteoffDocument poster,
                         boolean isUsingOrgAcctDefaultWriteoffFAU,
                         boolean isUsingChartForWriteoff,
                         String chartOfAccountsCode)