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

All Known Implementing Classes:

CustomerInvoiceDocumentServiceImpl

public interface CustomerInvoiceDocumentService

Method Summary

Collection<CustomerInvoiceDocument>	attachWorkflowHeadersToTheInvoices(Collection<CustomerInvoiceDocument> invoices) Gets invoices without workflow headers, retrieves the workflow headers and returns invoices with workflow headers.
boolean	checkIfInvoiceNumberIsFinal(String invDocumentNumber)
void	closeCustomerInvoiceDocument(CustomerInvoiceDocument customerInvoiceDocument) This method updates the open invoice indicator if amounts have been completely paid off
void	convertDiscountsToPaidApplieds(CustomerInvoiceDocument invoice) Converts discount lines on the customer invoice document to paidapplieds.
Collection<CustomerInvoiceDocument>	getAllOpenCustomerInvoiceDocuments() Retrieves all invoice documents that are Open with outstanding balances, including workflow headers.
Collection<CustomerInvoiceDocument>	getAllOpenCustomerInvoiceDocumentsWithoutWorkflow() Retrieves all invoice documents that are Open with outstanding balances.
Customer	getCustomerByInvoiceDocumentNumber(String documentNumber)
Customer	getCustomerByOrganizationInvoiceNumber(String invoiceNumber)
Collection<CustomerInvoiceDetail>	getCustomerInvoiceDetailsForCustomerInvoiceDocument(CustomerInvoiceDocument customerInvoiceDocument)
Collection<CustomerInvoiceDetail>	getCustomerInvoiceDetailsForCustomerInvoiceDocument(String customerInvoiceDocumentNumber)
Collection<CustomerInvoiceDetail>	getCustomerInvoiceDetailsForCustomerInvoiceDocumentWithCaching(CustomerInvoiceDocument customerInvoiceDocument) Cached for better performance
Collection<CustomerInvoiceDocument>	getCustomerInvoiceDocumentsByAccountNumber(String accountNumber)
List<CustomerInvoiceDocument>	getCustomerInvoiceDocumentsByBillingChartAndOrg(String chartOfAccountsCode, String organizationCode)
Collection<CustomerInvoiceDocument>	getCustomerInvoiceDocumentsByCustomerNumber(String customerNumber)
List<CustomerInvoiceDocument>	getCustomerInvoiceDocumentsByProcessingChartAndOrg(String chartOfAccountsCode, String organizationCode)
CustomerInvoiceDocument	getInvoiceByInvoiceDocumentNumber(String invoiceDocumentNumber)
CustomerInvoiceDocument	getInvoiceByOrganizationInvoiceNumber(String organizationInvoiceNumber)
Collection<NonInvoicedDistribution>	getNonInvoicedDistributionsForInvoice(String documentNumber)
org.kuali.rice.kns.util.KualiDecimal	getNonInvoicedTotalForInvoice(CustomerInvoiceDocument invoice)
org.kuali.rice.kns.util.KualiDecimal	getNonInvoicedTotalForInvoice(String documentNumber)
org.kuali.rice.kns.util.KualiDecimal	getOpenAmountForCustomerInvoiceDocument(CustomerInvoiceDocument customerInvoiceDocument) This method...
org.kuali.rice.kns.util.KualiDecimal	getOpenAmountForCustomerInvoiceDocument(String customerInvoiceDocumentNumber) This method...
Collection<CustomerInvoiceDocument>	getOpenInvoiceDocumentsByCustomerName(String customerName) Retrieves all Open Invoices for the given Customer Name.
Collection	getOpenInvoiceDocumentsByCustomerNameByCustomerType(String customerName, String customerTypeCode) Retrieves all Open Invoices for the given Customer Name and Customer Type Code Note that the customerName field is turned into a 'LIKE customerName*' query.
Collection<CustomerInvoiceDocument>	getOpenInvoiceDocumentsByCustomerNumber(String customerNumber) Retrieves all Open Invoices for this given Customer Number.
Collection<CustomerInvoiceDocument>	getOpenInvoiceDocumentsByCustomerType(String customerTypeCode) Retrieves all Open Invoices for the given Customer Type Code.
org.kuali.rice.kns.util.KualiDecimal	getOriginalTotalAmountForCustomerInvoiceDocument(CustomerInvoiceDocument customerInvoiceDocument)
org.kuali.rice.kns.util.KualiDecimal	getPaidAppliedTotalForInvoice(CustomerInvoiceDocument invoice)
org.kuali.rice.kns.util.KualiDecimal	getPaidAppliedTotalForInvoice(String documentNumber)
List<CustomerInvoiceDocument>	getPrintableCustomerInvoiceDocumentsByBillingChartAndOrg(String chartOfAccountsCode, String organizationCode)
List<CustomerInvoiceDocument>	getPrintableCustomerInvoiceDocumentsByInitiatorPrincipalName(String initiatorPrincipalName)
List<CustomerInvoiceDocument>	getPrintableCustomerInvoiceDocumentsByProcessingChartAndOrg(String chartOfAccountsCode, String organizationCode)
List<CustomerInvoiceDocument>	getPrintableCustomerInvoiceDocumentsForBillingStatementByBillingChartAndOrg(String chartOfAccountsCode, String organizationCode)
void	loadCustomerAddressesForCustomerInvoiceDocument(CustomerInvoiceDocument customerInvoiceDocument) If the customer number and address identifiers are present, display customer information
void	setupDefaultValuesForCopiedCustomerInvoiceDocument(CustomerInvoiceDocument customerInvoiceDocument) This method sets up default values for customer invoice document when copied.
void	setupDefaultValuesForNewCustomerInvoiceDocument(CustomerInvoiceDocument document) This method sets up default values for customer invoice document on initiation.

Method Detail

convertDiscountsToPaidApplieds

void convertDiscountsToPaidApplieds(CustomerInvoiceDocument invoice)

Converts discount lines on the customer invoice document to paidapplieds. This method is only intended to be used once the document is at least in the Processed state, and will throw an error if used on a document in an earlier state. This method is intended to be called from the CustomerInvoiceDocument.handleRouteStatusChange

Parameters:

invoice - A populated Invoice document that is at least PROCESSED.

getAllOpenCustomerInvoiceDocuments

Collection<CustomerInvoiceDocument> getAllOpenCustomerInvoiceDocuments()

Retrieves all invoice documents that are Open with outstanding balances, including workflow headers.

Returns:

A collection of CustomerInvoiceDocument documents, or an empty list of no matches.

getAllOpenCustomerInvoiceDocumentsWithoutWorkflow

Collection<CustomerInvoiceDocument> getAllOpenCustomerInvoiceDocumentsWithoutWorkflow()

Retrieves all invoice documents that are Open with outstanding balances. Will NOT retrieve workflow headers, so results of this are not suitable for using to route, save, or otherwise perform workflow operations upon.

Returns:

attachWorkflowHeadersToTheInvoices

Collection<CustomerInvoiceDocument> attachWorkflowHeadersToTheInvoices(Collection<CustomerInvoiceDocument> invoices)

Gets invoices without workflow headers, retrieves the workflow headers and returns invoices with workflow headers.

Returns:

getOpenInvoiceDocumentsByCustomerNumber

Collection<CustomerInvoiceDocument> getOpenInvoiceDocumentsByCustomerNumber(String customerNumber)

Retrieves all Open Invoices for this given Customer Number. IMPORTANT - Workflow headers and status are not retrieved by this method, only the raw Customer Invoice Document from the Database. If you need a full workflow document, you can do use DocumentService to retrieve each by document number.

Parameters:

customerNumber -

Returns:

getOpenInvoiceDocumentsByCustomerNameByCustomerType

Collection getOpenInvoiceDocumentsByCustomerNameByCustomerType(String customerName,
                                                               String customerTypeCode)

Retrieves all Open Invoices for the given Customer Name and Customer Type Code Note that the customerName field is turned into a 'LIKE customerName*' query. IMPORTANT - Workflow headers and status are not retrieved by this method, only the raw Customer Invoice Document from the Database. If you need a full workflow document, you can do use DocumentService to retrieve each by document number.

Parameters:

customerName -

customerTypeCode -

Returns:

getOpenInvoiceDocumentsByCustomerName

Collection<CustomerInvoiceDocument> getOpenInvoiceDocumentsByCustomerName(String customerName)

Retrieves all Open Invoices for the given Customer Name. Note that this is a leading substring search, so whatever is entered into the customerName field is turned into a 'LIKE customerName*' query. IMPORTANT - Workflow headers and status are not retrieved by this method, only the raw Customer Invoice Document from the Database. If you need a full workflow document, you can do use DocumentService to retrieve each by document number.

Parameters:

customerName -

Returns:

getOpenInvoiceDocumentsByCustomerType

Collection<CustomerInvoiceDocument> getOpenInvoiceDocumentsByCustomerType(String customerTypeCode)

Retrieves all Open Invoices for the given Customer Type Code. IMPORTANT - Workflow headers and status are not retrieved by this method, only the raw Customer Invoice Document from the Database. If you need a full workflow document, you can do use DocumentService to retrieve each by document number.

Parameters:

customerTypeCode -

Returns:

setupDefaultValuesForNewCustomerInvoiceDocument

void setupDefaultValuesForNewCustomerInvoiceDocument(CustomerInvoiceDocument document)

This method sets up default values for customer invoice document on initiation.

Parameters:

document -

setupDefaultValuesForCopiedCustomerInvoiceDocument

void setupDefaultValuesForCopiedCustomerInvoiceDocument(CustomerInvoiceDocument customerInvoiceDocument)

This method sets up default values for customer invoice document when copied.

Parameters:

customerInvoiceDocument -

loadCustomerAddressesForCustomerInvoiceDocument

void loadCustomerAddressesForCustomerInvoiceDocument(CustomerInvoiceDocument customerInvoiceDocument)

If the customer number and address identifiers are present, display customer information

getCustomerInvoiceDocumentsByCustomerNumber

Collection<CustomerInvoiceDocument> getCustomerInvoiceDocumentsByCustomerNumber(String customerNumber)

Parameters:

customerNumber -

Returns:

getCustomerInvoiceDetailsForCustomerInvoiceDocument

Collection<CustomerInvoiceDetail> getCustomerInvoiceDetailsForCustomerInvoiceDocument(String customerInvoiceDocumentNumber)

Parameters:

customerInvoiceDocumentNumber -

Returns:

getCustomerInvoiceDetailsForCustomerInvoiceDocument

Collection<CustomerInvoiceDetail> getCustomerInvoiceDetailsForCustomerInvoiceDocument(CustomerInvoiceDocument customerInvoiceDocument)

Parameters:

customerInvoiceDocument -

Returns:

getCustomerInvoiceDetailsForCustomerInvoiceDocumentWithCaching

Collection<CustomerInvoiceDetail> getCustomerInvoiceDetailsForCustomerInvoiceDocumentWithCaching(CustomerInvoiceDocument customerInvoiceDocument)

Cached for better performance

Parameters:

customerInvoiceDocument -

Returns:

getCustomerByOrganizationInvoiceNumber

Customer getCustomerByOrganizationInvoiceNumber(String invoiceNumber)

Parameters:

invoiceNumber -

Returns:

getInvoiceByOrganizationInvoiceNumber

CustomerInvoiceDocument getInvoiceByOrganizationInvoiceNumber(String organizationInvoiceNumber)

Parameters:

organizationInvoiceNumber -

Returns:

getCustomerByInvoiceDocumentNumber

Customer getCustomerByInvoiceDocumentNumber(String documentNumber)

Parameters:

documentNumber -

Returns:

getInvoiceByInvoiceDocumentNumber

CustomerInvoiceDocument getInvoiceByInvoiceDocumentNumber(String invoiceDocumentNumber)

Parameters:

invoiceDocumentNumber -

Returns:

getPrintableCustomerInvoiceDocumentsByInitiatorPrincipalName

List<CustomerInvoiceDocument> getPrintableCustomerInvoiceDocumentsByInitiatorPrincipalName(String initiatorPrincipalName)

getPrintableCustomerInvoiceDocumentsByBillingChartAndOrg

List<CustomerInvoiceDocument> getPrintableCustomerInvoiceDocumentsByBillingChartAndOrg(String chartOfAccountsCode,
                                                                                       String organizationCode)

getPrintableCustomerInvoiceDocumentsForBillingStatementByBillingChartAndOrg

List<CustomerInvoiceDocument> getPrintableCustomerInvoiceDocumentsForBillingStatementByBillingChartAndOrg(String chartOfAccountsCode,
                                                                                                          String organizationCode)

getPrintableCustomerInvoiceDocumentsByProcessingChartAndOrg

List<CustomerInvoiceDocument> getPrintableCustomerInvoiceDocumentsByProcessingChartAndOrg(String chartOfAccountsCode,
                                                                                          String organizationCode)

getCustomerInvoiceDocumentsByBillingChartAndOrg

List<CustomerInvoiceDocument> getCustomerInvoiceDocumentsByBillingChartAndOrg(String chartOfAccountsCode,
                                                                              String organizationCode)

getCustomerInvoiceDocumentsByProcessingChartAndOrg

List<CustomerInvoiceDocument> getCustomerInvoiceDocumentsByProcessingChartAndOrg(String chartOfAccountsCode,
                                                                                 String organizationCode)

getCustomerInvoiceDocumentsByAccountNumber

Collection<CustomerInvoiceDocument> getCustomerInvoiceDocumentsByAccountNumber(String accountNumber)

getNonInvoicedDistributionsForInvoice

Collection<NonInvoicedDistribution> getNonInvoicedDistributionsForInvoice(String documentNumber)

Parameters:

documentNumber -

Returns:

getNonInvoicedTotalForInvoice

org.kuali.rice.kns.util.KualiDecimal getNonInvoicedTotalForInvoice(String documentNumber)

Parameters:

documentNumber -

Returns:

getNonInvoicedTotalForInvoice

org.kuali.rice.kns.util.KualiDecimal getNonInvoicedTotalForInvoice(CustomerInvoiceDocument invoice)

Parameters:

invoice -

Returns:

getPaidAppliedTotalForInvoice

org.kuali.rice.kns.util.KualiDecimal getPaidAppliedTotalForInvoice(String documentNumber)

Parameters:

documentNumber -

Returns:

getPaidAppliedTotalForInvoice

org.kuali.rice.kns.util.KualiDecimal getPaidAppliedTotalForInvoice(CustomerInvoiceDocument invoice)

Parameters:

invoice -

Returns:

closeCustomerInvoiceDocument

void closeCustomerInvoiceDocument(CustomerInvoiceDocument customerInvoiceDocument)

This method updates the open invoice indicator if amounts have been completely paid off

Parameters:

invoice -

getOpenAmountForCustomerInvoiceDocument

org.kuali.rice.kns.util.KualiDecimal getOpenAmountForCustomerInvoiceDocument(String customerInvoiceDocumentNumber)

This method...

Parameters:

customerInvoiceDocumentNumber -

Returns:

getOpenAmountForCustomerInvoiceDocument

org.kuali.rice.kns.util.KualiDecimal getOpenAmountForCustomerInvoiceDocument(CustomerInvoiceDocument customerInvoiceDocument)

This method...

Parameters:

customerInvoiceDocumentNumber -

Returns:

getOriginalTotalAmountForCustomerInvoiceDocument

org.kuali.rice.kns.util.KualiDecimal getOriginalTotalAmountForCustomerInvoiceDocument(CustomerInvoiceDocument customerInvoiceDocument)

checkIfInvoiceNumberIsFinal

boolean checkIfInvoiceNumberIsFinal(String invDocumentNumber)