com.crm.businessobject.financialtransactions

Class CRMBOCreditNoteBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.financialtransactions.CRMBOFinancialTransactionBean

com.crm.businessobject.financialtransactions.CRMBOCreditNoteBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOCreditNoteBean
extends CRMBOFinancialTransactionBean

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOCreditNoteBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
com.crm.dataobject.financialtransactions.CRMDOCreditNote	construct(com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionType creditNoteType, com.crm.dataobject.products.CRMDOProduct product, java.math.BigDecimal totalAmount)
java.math.BigDecimal	getAllocatedAmount(com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote) Gets allocated amout of a credit note.
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Gets the default association data objects of the financial transaction.
java.lang.Boolean	isTaxRateApplied(com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote) Checks if an applied tax rate exists for a credit note
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(java.lang.String orderBy, java.lang.Integer numberOfResults, java.lang.Integer offset, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionType type, com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionCategory category, java.util.ArrayList<java.lang.String> associations) Loads the credit note based on an Accounts Receivable
com.crm.dataobject.financialtransactions.CRMDOCreditNote	loadByBackOfficeCode(java.lang.String backOfficeCode) Loads an invoice by a back office code.
com.crm.dataobject.financialtransactions.CRMDOCreditNote	loadByBackOfficeCode(java.lang.String backOfficeCode, java.util.ArrayList<java.lang.String> associations) Loads an invoice by a back office code.
com.crm.dataobject.financialtransactions.CRMDOCreditNote	loadByCreatedByWalletTransaction(com.crm.dataobject.wallets.CRMDOWalletTransaction walletTransaction, java.util.ArrayList<java.lang.String> associations) Loads a credit note by a wallet transaction.
com.crm.dataobject.financialtransactions.CRMDOCreditNote	loadByNumber(java.lang.String transactionNumber, java.util.ArrayList<java.lang.String> associations) Loads a credit note by a transaction number.
com.crm.dataobject.financialtransactions.CRMDOCreditNote	loadByReferenceNumber(java.lang.String referenceNumber, java.util.ArrayList<java.lang.String> associations) Loads a credit note by a reference number.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadNonRelatedWithBillItem(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.Date date) Loads a list of the credit notes of the given account which are not included in a bill.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadNonRelatedWithBillItem(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.Date date, java.util.ArrayList<java.lang.String> associations) Loads a list of the credit notes of the given account which are not included in a bill.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadPending(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation, java.util.ArrayList<java.lang.String> associations) Find all financial transactions which: - in Draft or Pending Verification state
com.crm.dataobject.financialtransactions.CRMDOCreditNote	post(com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote) Posts a credit note.
com.crm.dataobject.financialtransactions.CRMDOCreditNote	post(com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote, com.crm.dataobject.platform.CRMDONumberScheme numberScheme) Posts a credit note.
com.crm.dataobject.financialtransactions.CRMDOCreditNote	post(com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote, com.crm.dataobject.platform.CRMDONumberScheme numberScheme, com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod) Posts a credit note.
com.crm.dataobject.financialtransactions.CRMDOCreditNote	post(com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote, com.crm.dataobject.platform.CRMDONumberScheme numberScheme, com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod, com.crm.dataobject.platform.CRMDOTaxDefinition taxDefinition) Posts a credit note.
com.crm.dataobject.financialtransactions.CRMDOCreditNote	post(com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote, com.crm.dataobject.platform.CRMDONumberScheme numberScheme, com.crm.dataobject.platform.CRMDOTaxDefinition taxDefinition) Posts a credit note.
com.crm.dataobject.financialtransactions.CRMDOCreditNote	post(com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote, com.crm.dataobject.platform.CRMDOTaxDefinition taxDefinition) Posts a credit note.
com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction	reject(com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction finTransaction, com.crm.dataobject.financialtransactions.CRMDOFinancialTransactionRejectionReason rejectionReason) Rejects a financial transaction.
com.crm.dataobject.financialtransactions.CRMDOCreditNote	setDefaultType(com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote)

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

anonymizeContactFT, calculateAmounts, calculateAmounts, calculateAmountsFromTotals, calculateAmountsFromTotals, construct, getMinimumPostedDate, load, load, load, loadNonPosted, loadNonPostedTransactionsWithAccountPeriod, loadPostedTransactionsWithoutAccountPeriod, loadTransactionsWithInvalidAccountPeriod, setTaxPercentage, setVaPercentage, setVaPercentage, setVatInformation, setVatInformation, validatePosting

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, load, load, load, load, load, loadAll, loadAll, loadAll, loadAllEntityStatusDO, loadAllEntityStatusDO, loadDataObject, loadDataObject, loadDataObject, loadDataObjects, loadDataObjects, loadEntityCategoryDO, loadEntityCategoryDO, loadEntityDO, loadEntityDO, loadEntityStatusDO, loadEntityStatusDO, parseAssociations, 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

CRMBOCreditNoteBean

public CRMBOCreditNoteBean()

Default constructor.

Method Detail

setDefaultType

public com.crm.dataobject.financialtransactions.CRMDOCreditNote setDefaultType(com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote)
                                                                        throws java.lang.Exception

Throws:

java.lang.Exception

construct

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

Throws:

java.lang.Exception

getDefaultAssociations

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

Description copied from class: CRMBOFinancialTransactionBean

Gets the default association data objects of the financial transaction.

Overrides:

getDefaultAssociations in class CRMBOFinancialTransactionBean

Returns:

a list of data objects associated to the financial transaction

post

public com.crm.dataobject.financialtransactions.CRMDOCreditNote post(com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote)
                                                              throws java.lang.Exception,
                                                                     com.crm.exception.financialtransactions.FTPostException

Posts a credit note.

Parameters:

creditNote - a credit note

Returns:

the updated posted credit note

Throws:

java.lang.Exception

com.crm.exception.financialtransactions.FTPostException

post

public com.crm.dataobject.financialtransactions.CRMDOCreditNote post(com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote,
                                                                     com.crm.dataobject.platform.CRMDOTaxDefinition taxDefinition)
                                                              throws java.lang.Exception,
                                                                     com.crm.exception.financialtransactions.FTPostException

Posts a credit note.

Parameters:

creditNote - a credit note

Returns:

the updated posted credit note

Throws:

java.lang.Exception

com.crm.exception.financialtransactions.FTPostException

post

public com.crm.dataobject.financialtransactions.CRMDOCreditNote post(com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote,
                                                                     com.crm.dataobject.platform.CRMDONumberScheme numberScheme)
                                                              throws java.lang.Exception,
                                                                     com.crm.exception.financialtransactions.FTPostException

Posts a credit note.

Parameters:

creditNote - a credit note

numberScheme - the number scheme for CREDITNOTES Sequence Number

Returns:

the updated posted credit note

Throws:

java.lang.Exception

com.crm.exception.financialtransactions.FTPostException

post

public com.crm.dataobject.financialtransactions.CRMDOCreditNote post(com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote,
                                                                     com.crm.dataobject.platform.CRMDONumberScheme numberScheme,
                                                                     com.crm.dataobject.platform.CRMDOTaxDefinition taxDefinition)
                                                              throws java.lang.Exception,
                                                                     com.crm.exception.financialtransactions.FTPostException

Posts a credit note.

Parameters:

creditNote - a credit note

numberScheme - the number scheme for CREDITNOTES Sequence Number

Returns:

the updated posted credit note

Throws:

java.lang.Exception

com.crm.exception.financialtransactions.FTPostException

post

public com.crm.dataobject.financialtransactions.CRMDOCreditNote post(com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote,
                                                                     com.crm.dataobject.platform.CRMDONumberScheme numberScheme,
                                                                     com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod)
                                                              throws java.lang.Exception,
                                                                     com.crm.exception.financialtransactions.FTPostException

Posts a credit note.

Parameters:

creditNote - a credit note

numberScheme - the number scheme for CREDITNOTES Sequence Number

accountingPeriod - the open accounting period

Returns:

the updated posted credit note

Throws:

java.lang.Exception

com.crm.exception.financialtransactions.FTPostException

post

public com.crm.dataobject.financialtransactions.CRMDOCreditNote post(com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote,
                                                                     com.crm.dataobject.platform.CRMDONumberScheme numberScheme,
                                                                     com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod,
                                                                     com.crm.dataobject.platform.CRMDOTaxDefinition taxDefinition)
                                                              throws java.lang.Exception,
                                                                     com.crm.exception.financialtransactions.FTPostException

Posts a credit note.

Parameters:

creditNote - a credit note

numberScheme - the number scheme for CREDITNOTES Sequence Number

accountingPeriod - the open accounting period

Returns:

the updated posted credit note

Throws:

java.lang.Exception

com.crm.exception.financialtransactions.FTPostException

getAllocatedAmount

public java.math.BigDecimal getAllocatedAmount(com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote)
                                        throws java.lang.Exception

Gets allocated amout of a credit note.

Parameters:

creditNote - a credit note

Returns:

the allocated amount of a credit note

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 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

loadByNumber

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

Loads a credit note by a transaction number.

Parameters:

transactionNumber - a transaction number

associations - a list of associations

Returns:

the credit note with specified transaction number

Throws:

java.lang.Exception

loadByReferenceNumber

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

Loads a credit note by a reference number.

Parameters:

referenceNumber - a reference number

associations - a list of associations

Returns:

the credit note with specified reference number

Throws:

java.lang.Exception

loadByCreatedByWalletTransaction

public com.crm.dataobject.financialtransactions.CRMDOCreditNote loadByCreatedByWalletTransaction(com.crm.dataobject.wallets.CRMDOWalletTransaction walletTransaction,
                                                                                                 java.util.ArrayList<java.lang.String> associations)
                                                                                          throws java.lang.Exception

Loads a credit note by a wallet transaction.

Parameters:

walletTransaction - the wallet transaction that created the credit note

associations - a list of associations

Returns:

the loaded credit note

Throws:

java.lang.Exception

load

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

Loads the credit note based on an Accounts Receivable

Parameters:

accountReceivable - a financial account (required)

type - a financial transaction type (optional)

category - a financial transaction category (optional)

numberOfResults - the number of charges to load

orderBy - the ordering field

offset - how many results to skip (pagination)

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

Returns:

a list of credit notes

Throws:

java.lang.Exception

loadByBackOfficeCode

public com.crm.dataobject.financialtransactions.CRMDOCreditNote 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.CRMDOCreditNote 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

isTaxRateApplied

public java.lang.Boolean isTaxRateApplied(com.crm.dataobject.financialtransactions.CRMDOCreditNote creditNote)
                                   throws java.lang.Exception

Checks if an applied tax rate exists for a credit note

Parameters:

creditNote - - the credit note to check

Returns:

true if at least one applied tax rate exists, false if not

Throws:

java.lang.Exception

loadNonRelatedWithBillItem

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadNonRelatedWithBillItem(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                java.util.Date date)
                                                                         throws java.lang.Exception

Loads a list of the credit notes of the given account which are not included in a bill.

Parameters:

accountReceivable - - the account to load the credit notes for

Returns:

a list of the credit notes which are not included in a bill

Throws:

java.lang.Exception

loadNonRelatedWithBillItem

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadNonRelatedWithBillItem(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                java.util.Date date,
                                                                                java.util.ArrayList<java.lang.String> associations)
                                                                         throws java.lang.Exception

Loads a list of the credit notes of the given account which are not included in a bill.

Parameters:

accountReceivable - - the account to load the credit notes for

date - - the date which defines the less posted date that retrieved credit notes should have

associations - - a list of associations

Returns:

a list of the credit notes which are not included in a bill

Throws:

java.lang.Exception

loadPending

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadPending(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation,
                                                                 java.util.ArrayList<java.lang.String> associations)
                                                          throws java.lang.Exception

Find all financial transactions which: - in Draft or Pending Verification state

Returns:

a list of financial transactions full fill the criteria

Throws:

java.lang.Exception