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

All Known Implementing Classes:

CustomerInvoiceDetailServiceImpl

public interface CustomerInvoiceDetailService

This class provides services related to the customer invoice document

Method Summary

String	getAccountsReceivableObjectCodeBasedOnReceivableParameter(CustomerInvoiceDetail customerInvoiceDetail) This method returns the correct accounts receivable object code based on a receivable parameter.
CustomerInvoiceDetail	getCustomerInvoiceDetail(String documentNumber, Integer sequenceNumber) This method returns a customer invoice detail based on invoice document number and invoice item sequence number
CustomerInvoiceDetail	getCustomerInvoiceDetailFromCustomerInvoiceItemCode(String invoiceItemCode, String chartOfAccountsCode, String organizationCode) This method...
CustomerInvoiceDetail	getCustomerInvoiceDetailFromCustomerInvoiceItemCodeForCurrentUser(String invoiceItemCode) This method returns a customer invoice detail from a customer invoice item code for a current user
CustomerInvoiceDetail	getCustomerInvoiceDetailFromOrganizationAccountingDefault(Integer universityFiscalYear, String chartOfAccountsCode, String organizationCode) This method returns a customer invoice detail for use on the CustomerInvoiceDocumentAction.
CustomerInvoiceDetail	getCustomerInvoiceDetailFromOrganizationAccountingDefaultForCurrentYear() This method returns a customer invoice detail for current user and current fiscal year for use on the CustomerInvoiceDocumentAction.
Collection<CustomerInvoiceDetail>	getCustomerInvoiceDetailsForInvoice(CustomerInvoiceDocument customerInvoiceDocument)
Collection<CustomerInvoiceDetail>	getCustomerInvoiceDetailsForInvoice(String customerInvoiceDocumentNumber)
Collection<CustomerInvoiceDetail>	getCustomerInvoiceDetailsForInvoiceWithCaching(String customerInvoiceDocumentNumber) Cached for better performance...
List<String>	getCustomerInvoiceDocumentNumbersByAccountNumber(String accountNumber) This method ...
CustomerInvoiceDetail	getDiscountCustomerInvoiceDetail(CustomerInvoiceDetail customerInvoiceDetail, Integer universityFiscalYear, String chartOfAccountsCode, String organizationCode) This method returns a discount customer invoice detail based on a customer invoice detail, the chart of accounts code
CustomerInvoiceDetail	getDiscountCustomerInvoiceDetailForCurrentYear(CustomerInvoiceDetail customerInvoiceDetail, CustomerInvoiceDocument customerInvoiceDocument) This method returns a discount customer invoice detail for the current year
void	prepareCustomerInvoiceDetailForAdd(CustomerInvoiceDetail customerInvoiceDetail, CustomerInvoiceDocument customerInvoiceDocument) This method is used to make sure the amounts are calculated correctly and the correct AR object code is in place
void	recalculateCustomerInvoiceDetail(CustomerInvoiceDocument document, CustomerInvoiceDetail customerInvoiceDetail) This method is used to recalculate a customer invoice detail based on updated values
void	updateAccountsForCorrespondingDiscount(CustomerInvoiceDetail parentDiscountCustomerInvoiceDetail) This method is used to update account for corresponding discount line based on parent line's account
void	updateAccountsReceivableObjectCode(CustomerInvoiceDetail customerInvoiceDetail) This method is used to update the accounts receivable object code if receivable options 1 or 2 are selected.

Method Detail

getCustomerInvoiceDetailFromOrganizationAccountingDefault

CustomerInvoiceDetail getCustomerInvoiceDetailFromOrganizationAccountingDefault(Integer universityFiscalYear,
                                                                                String chartOfAccountsCode,
                                                                                String organizationCode)

This method returns a customer invoice detail for use on the CustomerInvoiceDocumentAction. If corresponding organization accounting default exists for billing chart and org, then the customer invoice detail is defaulted using the organization accounting default values.

Returns:

getCustomerInvoiceDetailFromOrganizationAccountingDefaultForCurrentYear

CustomerInvoiceDetail getCustomerInvoiceDetailFromOrganizationAccountingDefaultForCurrentYear()

This method returns a customer invoice detail for current user and current fiscal year for use on the CustomerInvoiceDocumentAction. If corresponding organization accounting default exists for billing chart and org, then the customer invoice detail is defaulted using the organization accounting default values.

Returns:

getCustomerInvoiceDocumentNumbersByAccountNumber

List<String> getCustomerInvoiceDocumentNumbersByAccountNumber(String accountNumber)

This method ...

Parameters:

accountNumber -

Returns:

getCustomerInvoiceDetailFromCustomerInvoiceItemCodeForCurrentUser

CustomerInvoiceDetail getCustomerInvoiceDetailFromCustomerInvoiceItemCodeForCurrentUser(String invoiceItemCode)

This method returns a customer invoice detail from a customer invoice item code for a current user

Parameters:

invoiceItemCode -

Returns:

getCustomerInvoiceDetailFromCustomerInvoiceItemCode

CustomerInvoiceDetail getCustomerInvoiceDetailFromCustomerInvoiceItemCode(String invoiceItemCode,
                                                                          String chartOfAccountsCode,
                                                                          String organizationCode)

This method...

Parameters:

invoiceItemCode -

chartOfAccountsCode -

organizationCode -

Returns:

getDiscountCustomerInvoiceDetail

CustomerInvoiceDetail getDiscountCustomerInvoiceDetail(CustomerInvoiceDetail customerInvoiceDetail,
                                                       Integer universityFiscalYear,
                                                       String chartOfAccountsCode,
                                                       String organizationCode)

This method returns a discount customer invoice detail based on a customer invoice detail, the chart of accounts code

Parameters:

customerInvoiceDetail -

chartOfAccountsCode -

organizationCode -

Returns:

getDiscountCustomerInvoiceDetailForCurrentYear

CustomerInvoiceDetail getDiscountCustomerInvoiceDetailForCurrentYear(CustomerInvoiceDetail customerInvoiceDetail,
                                                                     CustomerInvoiceDocument customerInvoiceDocument)

This method returns a discount customer invoice detail for the current year

Parameters:

customerInvoiceDetail -

chartOfAccountsCode -

organizationCode -

Returns:

getCustomerInvoiceDetail

CustomerInvoiceDetail getCustomerInvoiceDetail(String documentNumber,
                                               Integer sequenceNumber)

This method returns a customer invoice detail based on invoice document number and invoice item sequence number

Parameters:

documentNumber -

sequenceNumber -

Returns:

recalculateCustomerInvoiceDetail

void recalculateCustomerInvoiceDetail(CustomerInvoiceDocument document,
                                      CustomerInvoiceDetail customerInvoiceDetail)

This method is used to recalculate a customer invoice detail based on updated values

Parameters:

customerInvoiceDetail -

updateAccountsForCorrespondingDiscount

void updateAccountsForCorrespondingDiscount(CustomerInvoiceDetail parentDiscountCustomerInvoiceDetail)

This method is used to update account for corresponding discount line based on parent line's account

Parameters:

parentDiscountCustomerInvoiceDetail -

updateAccountsReceivableObjectCode

void updateAccountsReceivableObjectCode(CustomerInvoiceDetail customerInvoiceDetail)

This method is used to update the accounts receivable object code if receivable options 1 or 2 are selected.

Parameters:

customerInvoiceDetail -

getAccountsReceivableObjectCodeBasedOnReceivableParameter

String getAccountsReceivableObjectCodeBasedOnReceivableParameter(CustomerInvoiceDetail customerInvoiceDetail)

This method returns the correct accounts receivable object code based on a receivable parameter.

Returns:

prepareCustomerInvoiceDetailForAdd

void prepareCustomerInvoiceDetailForAdd(CustomerInvoiceDetail customerInvoiceDetail,
                                        CustomerInvoiceDocument customerInvoiceDocument)

This method is used to make sure the amounts are calculated correctly and the correct AR object code is in place

Parameters:

customerInvoiceDetail -

customerInvoiceDocument -

getCustomerInvoiceDetailsForInvoice

Collection<CustomerInvoiceDetail> getCustomerInvoiceDetailsForInvoice(CustomerInvoiceDocument customerInvoiceDocument)

Parameters:

customerInvoiceDocument -

Returns:

getCustomerInvoiceDetailsForInvoice

Collection<CustomerInvoiceDetail> getCustomerInvoiceDetailsForInvoice(String customerInvoiceDocumentNumber)

Parameters:

customerInvoiceDocumentNumber -

Returns:

getCustomerInvoiceDetailsForInvoiceWithCaching

Collection<CustomerInvoiceDetail> getCustomerInvoiceDetailsForInvoiceWithCaching(String customerInvoiceDocumentNumber)

Cached for better performance...

Parameters:

customerInvoiceDocumentNumber -

Returns:

List of customer invoice details