com.crm.businessobject.financialtransactions

Class CRMBOInvoiceBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.financialtransactions.CRMBOFinancialTransactionBean

com.crm.businessobject.financialtransactions.CRMBOInvoiceBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOInvoiceBean
extends CRMBOFinancialTransactionBean

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOInvoiceBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
com.crm.dataobject.financialtransactions.CRMDOInvoice	cancel(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice) Cancels an invoice.
com.crm.dataobject.financialtransactions.CRMDOInvoice	construct(com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionType invoiceType, com.crm.dataobject.products.CRMDOProduct product, java.math.BigDecimal totalAmount) Creates a new invoice based on parameters.
com.crm.dataobject.financialtransactions.CRMDOInvoice	construct(com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionType invoiceType, com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote) Creates a new invoice based on parameters.
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Gets the default association data objects of the invoice.
java.math.BigDecimal	getOutstandingAmount(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice) Calculates the unpaid amount for an invoice.
java.math.BigDecimal	getUnsettledAmount(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice) Calculates the unsettled amount for an invoice.
java.lang.Boolean	isCancelled(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice) Checks if an invoice is cancelled or not
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionType type, com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionCategory category, java.util.ArrayList<java.lang.String> assocations) Loads the invoice based on an Accounts Receivable
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.billing.CRMDOBill bill) Loads the invoice based on a bill
com.crm.dataobject.financialtransactions.CRMDOInvoice	loadByBackOfficeCode(java.lang.String backOfficeCode) Loads an invoice by a back office code.
com.crm.dataobject.financialtransactions.CRMDOInvoice	loadByBackOfficeCode(java.lang.String backOfficeCode, java.util.ArrayList<java.lang.String> associations) Loads an invoice by a back office code.
com.crm.dataobject.financialtransactions.CRMDOInvoice	loadByNumber(java.lang.String transactionNumber, java.util.ArrayList<java.lang.String> associations) Loads an invoice by a transaction number.
com.crm.dataobject.financialtransactions.CRMDOInvoice	loadByReferenceNumber(java.lang.String referenceNumber, java.util.ArrayList<java.lang.String> associations) Loads an invoice by a reference number.
com.crm.dataobject.financialtransactions.CRMDOInvoice	post(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice) Posts invoice.
com.crm.dataobject.financialtransactions.CRMDOInvoice	post(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice, com.crm.dataobject.accounts.CRMDOAccountDefinition accountDefinition, com.crm.dataobject.platform.CRMDONumberScheme numberScheme) Posts invoice.
com.crm.dataobject.financialtransactions.CRMDOInvoice	post(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice, com.crm.dataobject.accounts.CRMDOAccountDefinition accountDefinition, com.crm.dataobject.platform.CRMDONumberScheme numberScheme, com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod) Posts invoice.
com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction	reject(com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction finTransaction, com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionRejectionReason rejectionReason) Rejects a draft financial transaction.
com.crm.dataobject.financialtransactions.CRMDOInvoice	setDefaultType(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice)
com.crm.dataobject.financialtransactions.CRMDOInvoice	setDueDate(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice, com.crm.dataobject.accounts.CRMDOAccountDefinition accountDefinition) Sets the due date of an invoice.
com.crm.dataobject.financialtransactions.CRMDOInvoice	writeOff(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice) Writes off an invoice.

Methods inherited from class com.crm.businessobject.financialtransactions.CRMBOFinancialTransactionBean

calculateAmounts, calculateAmountsFromTotals, construct, getMinimumPostedDate, load, load, load, loadNonPosted, loadNonPostedTransactionsWithAccountPeriod, loadPostedTransactionsWithoutAccountPeriod, loadTransactionsWithInvalidAccountPeriod, setVaPercentage

Methods inherited from class com.crm.businessobject.CRMBO

construct, construct, construct, construct, construct, construct, construct, construct, createAndUpdate, delete, delete, delete, getDOName, getDOName, getNextSequenceNumber, getNextSequenceNumber, getNumberScheme, isAssignable, load, load, load, load, load, load, load, load, load, loadAll, loadAll, loadAll, loadAllEntityStatusDO, loadAllEntityStatusDO, loadDataObject, loadDataObject, loadDataObject, loadDataObjects, loadEntityCategoryDO, loadEntityCategoryDO, loadEntityDO, loadEntityDO, loadEntityStatusDO, loadEntityStatusDO, parseAssociations, parseAssociations, save, save, save, saveCRMDOCollection, saveImages, setMandatoryFields, setNumberScheme, validateAndDelete, validateAndSave, validateAndSave, validateAndSave, validateApprovalRequestEntity, validateFormatSettings, validateFormatSettings, validateOnDelete, validateOnDelete, validateOnDelete, validateOnSave, validateOnSave, validateOnSave

Methods inherited from class com.crm.businessobject.CRMBase

deepCopy, dispatch, getCRMSession, getCRMSessionHandle, getCurrentDate, getEJBHomeInterface, getInitialContext, getSessionContext, invoke, setCRMSessionHandle, setInitialContext, setSessionContext

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CRMBOInvoiceBean

public CRMBOInvoiceBean()

Default constructor.

Method Detail

setDefaultType

public com.crm.dataobject.financialtransactions.CRMDOInvoice setDefaultType(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice)
                                                                     throws java.lang.Exception

Throws:

java.lang.Exception

construct

public com.crm.dataobject.financialtransactions.CRMDOInvoice construct(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                                       com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionType invoiceType,
                                                                       com.crm.dataobject.products.CRMDOProduct product,
                                                                       java.math.BigDecimal totalAmount)
                                                                throws java.lang.Exception

Creates a new invoice based on parameters.

Parameters:

account - - the related Accounts Receivable

invoiceType - - the related financial transaction type

product - - the related product

totalAmount - - the related total amount

Returns:

the created invoice

Throws:

java.lang.Exception

construct

public com.crm.dataobject.financialtransactions.CRMDOInvoice construct(com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionType invoiceType,
                                                                       com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote)
                                                                throws java.lang.Exception

Creates a new invoice based on parameters.

Parameters:

invoiceType - - the related financial transaction type

creditNote - - the related credit note

Returns:

the created invoice

Throws:

java.lang.Exception

getDefaultAssociations

public java.util.ArrayList<java.lang.String> getDefaultAssociations()

Gets the default association data objects of the invoice.

Overrides:

getDefaultAssociations in class CRMBOFinancialTransactionBean

Returns:

a list of data objects associated to the invoice

post

public com.crm.dataobject.financialtransactions.CRMDOInvoice post(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice)
                                                           throws java.lang.Exception

Posts invoice. (Sets posted date, generates transaction number, performs allocations).

Parameters:

invoice - an invoice

Returns:

the updated invoice

Throws:

java.lang.Exception

post

public com.crm.dataobject.financialtransactions.CRMDOInvoice post(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice,
                                                                  com.crm.dataobject.accounts.CRMDOAccountDefinition accountDefinition,
                                                                  com.crm.dataobject.platform.CRMDONumberScheme numberScheme)
                                                           throws java.lang.Exception,
                                                                  com.crm.exception.financialtransactions.FTPostException,
                                                                  com.crm.exception.InvalidValueException

Posts invoice. (Sets posted date, generates transaction number, performs allocations).

Parameters:

invoice - an invoice

accountDefinition - an account definition

numberScheme - the number scheme for INVOICES Sequence Number

Returns:

the updated invoice

Throws:

com.crm.exception.financialtransactions.FTPostException

com.crm.exception.InvalidValueException

java.lang.Exception

post

public com.crm.dataobject.financialtransactions.CRMDOInvoice post(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice,
                                                                  com.crm.dataobject.accounts.CRMDOAccountDefinition accountDefinition,
                                                                  com.crm.dataobject.platform.CRMDONumberScheme numberScheme,
                                                                  com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod)
                                                           throws java.lang.Exception,
                                                                  com.crm.exception.financialtransactions.FTPostException,
                                                                  com.crm.exception.InvalidValueException

Posts invoice. (Sets posted date, generates transaction number, performs allocations).

Parameters:

invoice - an invoice

accountDefinition - an account definition

numberScheme - the number scheme for INVOICES Sequence Number

accountingPeriod - the open accounting period

Returns:

the updated invoice

Throws:

com.crm.exception.financialtransactions.FTPostException

com.crm.exception.InvalidValueException

java.lang.Exception

cancel

public com.crm.dataobject.financialtransactions.CRMDOInvoice cancel(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice)
                                                             throws java.lang.Exception,
                                                                    com.crm.exception.financialtransactions.FTCancelException,
                                                                    com.crm.exception.financialtransactions.FTAlreadyCancelledException,
                                                                    com.crm.exception.financialtransactions.CannotCancelInvoiceRelatedWithPhysicalGoodSaleException

Cancels an invoice. (Sets the life cycle state to draft, generates and sets the reference number and the issued date)

Parameters:

invoice - an invoice

Returns:

the updated invoice

Throws:

com.crm.exception.financialtransactions.CannotCancelInvoiceRelatedWithPhysicalGoodSaleException

com.crm.exception.financialtransactions.FTCancelException

com.crm.exception.financialtransactions.FTAlreadyCancelledException

java.lang.Exception

writeOff

public com.crm.dataobject.financialtransactions.CRMDOInvoice writeOff(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice)
                                                               throws java.lang.Exception,
                                                                      com.crm.exception.financialtransactions.InvoiceWriteOffException,
                                                                      com.crm.exception.financialtransactions.AlreadyWrittenOffException

Writes off an invoice. (Sets the life cycle state to written off)

Parameters:

invoice - an invoice to write off

Returns:

the updated invoice

Throws:

com.crm.exception.financialtransactions.AlreadyWrittenOffException

com.crm.exception.financialtransactions.InvoiceWriteOffException

java.lang.Exception

setDueDate

public com.crm.dataobject.financialtransactions.CRMDOInvoice setDueDate(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice,
                                                                        com.crm.dataobject.accounts.CRMDOAccountDefinition accountDefinition)
                                                                 throws java.lang.Exception

Sets the due date of an invoice.

Parameters:

invoice - an invoice

Returns:

the updated invoice

Throws:

java.lang.Exception

reject

public com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction reject(com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction finTransaction,
                                                                                 com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionRejectionReason rejectionReason)
                                                                          throws java.lang.Exception,
                                                                                 com.crm.exception.financialtransactions.InvalidStateRejectionException,
                                                                                 com.crm.exception.financialtransactions.FinTransactionRejectionException

Rejects a draft financial transaction.

Overrides:

reject in class CRMBOFinancialTransactionBean

Parameters:

finTransaction - a financial transaction (required)

rejectionReason - a rejection reason (required)

Returns:

the updated financial transaction

Throws:

java.lang.Exception

com.crm.exception.financialtransactions.InvalidStateRejectionException

com.crm.exception.financialtransactions.FinTransactionRejectionException

getOutstandingAmount

public java.math.BigDecimal getOutstandingAmount(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice)
                                          throws java.lang.Exception

Calculates the unpaid amount for an invoice.

Parameters:

invoice - an invoice

Returns:

a value of unpaid amount

Throws:

java.lang.Exception

getUnsettledAmount

public java.math.BigDecimal getUnsettledAmount(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice)
                                        throws java.lang.Exception

Calculates the unsettled amount for an invoice.

Parameters:

invoice - an invoice

Returns:

a value of unsettled amount

Throws:

java.lang.Exception

isCancelled

public java.lang.Boolean isCancelled(com.crm.dataobject.financialtransactions.CRMDOInvoice invoice)
                              throws java.lang.Exception

Checks if an invoice is cancelled or not

Parameters:

invoice - an invoice

Returns:

true if the invoice is cancelled, false if it is not

Throws:

java.lang.Exception

loadByNumber

public com.crm.dataobject.financialtransactions.CRMDOInvoice loadByNumber(java.lang.String transactionNumber,
                                                                          java.util.ArrayList<java.lang.String> associations)
                                                                   throws java.lang.Exception

Loads an invoice by a transaction number.

Parameters:

transactionNumber - a transaction number

associations - a list of associations

Returns:

the invoice with specified transaction number

Throws:

java.lang.Exception

loadByReferenceNumber

public com.crm.dataobject.financialtransactions.CRMDOInvoice loadByReferenceNumber(java.lang.String referenceNumber,
                                                                                   java.util.ArrayList<java.lang.String> associations)
                                                                            throws java.lang.Exception

Loads an invoice by a reference number.

Parameters:

referenceNumber - a reference number

associations - a list of associations

Returns:

the invoice with specified reference number

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                          com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionType type,
                                                          com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionCategory category,
                                                          java.util.ArrayList<java.lang.String> assocations)
                                                   throws java.lang.Exception

Loads the invoice based on an Accounts Receivable

Parameters:

accountReceivable - a financial account (required)

type - a financial transaction type (optional)

category - a financial transaction category (optional)

assocations - the associate object you want to initialize(optional)

Returns:

a list of invoices

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.billing.CRMDOBill bill)
                                                   throws java.lang.Exception

Loads the invoice based on a bill

Parameters:

bill - a bill data object (required)

Returns:

a list of invoices

Throws:

java.lang.Exception

loadByBackOfficeCode

public com.crm.dataobject.financialtransactions.CRMDOInvoice loadByBackOfficeCode(java.lang.String backOfficeCode)
                                                                           throws java.lang.Exception

Loads an invoice by a back office code.

Parameters:

backOfficeCode - a back office code

Returns:

the invoice with specified back office code

Throws:

java.lang.Exception

loadByBackOfficeCode

public com.crm.dataobject.financialtransactions.CRMDOInvoice loadByBackOfficeCode(java.lang.String backOfficeCode,
                                                                                  java.util.ArrayList<java.lang.String> associations)
                                                                           throws java.lang.Exception

Loads an invoice by a back office code.

Parameters:

backOfficeCode - a back office code

associations - a list of associations

Returns:

the invoice with specified back office code

Throws:

java.lang.Exception