CRMProcessNonSystemAccountReceivableBean

java.lang.Object
- com.crm.businessobject.CRMBase
- - com.crm.process.CRMProcess
  - - com.crm.process.accounts.CRMProcessNonSystemAccountReceivableBean

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CRMProcessCustomerAccountReceivableBean, CRMProcessOrganisationalAccountReceivableBean
```
public abstract class CRMProcessNonSystemAccountReceivableBean
extends CRMProcess
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CRMProcessNonSystemAccountReceivableBean()
Default constructor.

Constructors
Constructor and Description
`CRMProcessNonSystemAccountReceivableBean()` Default constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`com.crm.dataobject.accounts.CRMDOAccountReceivable`	`activate(com.crm.dataobject.accounts.CRMDOAccountReceivable account)` Activates an account.
`com.crm.dataobject.accounts.CRMDOAccountReceivableMember`	`addMemberInAGroup(com.crm.dataobject.accounts.CRMDOAccountReceivable parentAccountReceivable, com.crm.dataobject.accounts.CRMDOAccountReceivable memberAccountReceivable, com.crm.dataobject.accounts.AccountReceivableMemberFundingScope fundingScope, java.util.ArrayList<com.crm.dataobject.products.CRMDOProduct> products, java.util.ArrayList<com.crm.dataobject.products.CRMDOProductType> productTypes, java.util.ArrayList<com.crm.dataobject.products.CRMDOProductFamily> productFamilies)` Add Member Accounts Receivable in an account group At least on of the following must be specified: products, productTypes, productFamilies
`void`	`anonymizeContactAccounts(com.crm.dataobject.contactinfo.CRMDOContactInformation contact)` Anonymizes the given contact information account
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivable`	`applyCommonOperations(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Executes the common operations of the Account Receivable.
`java.util.Date`	`applyCreditPeriodRules(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accounts.CRMDOAccountDefinition accountDefinition, java.util.Date postedDate)` Calculates a date based on credit period rules.
`abstract com.crm.dataobject.CRMDO`	`applyOnEntity(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.CRMDO crmdo)` Associates an Accounts Receivable to a account based entity.
`java.math.BigDecimal`	`calculateAllowedExceededUsageAllowance(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.Date validityDate, com.crm.dataobject.billing.CRMDOUsageAuthorisation usageAuthorisation)` Calculate allowed exceeded Usage Allowance.
`java.math.BigDecimal`	`calculateBalance(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Calculate the balance for an account.
`java.math.BigDecimal`	`calculateBalance(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.Date asOfDate)` Calculate the balance for an account.
`com.crm.dataobject.accounts.CRMDOAccountReceivable`	`calculateConsumedUsageAllowance(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.Date validityDate, com.crm.dataobject.billing.CRMDOUsageAuthorisation usageAuthorisation)` Calculate Consumed Usage Allowance.
`java.math.BigDecimal`	`calculateCreditLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Return the credit limit on an account.
`java.math.BigDecimal`	`calculateCreditLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accounts.CRMDOAccountDefinition accountDefinition)` Return the credit limit on an account.
`com.crm.dataobject.accounts.CreditLimitStatus`	`calculateCreditLimitStatus(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Calculate the credit limit status for an account.
`java.math.BigDecimal`	`calculateOutstandingAmount(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Calculate the outstanding amount for an account.
`java.math.BigDecimal`	`calculateOutstandingAmount(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.Date asOfDate)` Calculate the outstanding amount for an account.
`com.crm.dataobject.accounts.CRMDOAccountReceivable`	`calculateRemainingUsageAllowance(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.Date validityDate, com.crm.dataobject.billing.CRMDOUsageAuthorisation usageAuthorisation)` Calculate Consumed Usage Allowance.
`com.crm.dataobject.accounts.CRMDOAccountReceivable`	`calculateRemainingUsageAllowanceWithoutLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.Date validityDate, com.crm.dataobject.billing.CRMDOUsageAuthorisation usageAuthorisation)` Calculate remaining usage allowance limit without limit.
`abstract java.lang.Boolean`	`canBeActivated(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Determine if a customer accounts receivable can be activated.
`java.lang.Boolean`	`canBeAddedInAGroupAsMember(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Determine if accounts receivable can be added in a group as a member
`java.lang.Boolean`	`canBeAddedInAGroupAsParent(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Determine if accounts receivable can be added in a group as a parent
`abstract java.lang.Boolean`	`canBeSuspended(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Determine if a customer accounts receivable can be suspended.
`abstract java.lang.Boolean`	`canBeTerminated(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Determine if a customer accounts receivable can be terminated.
`abstract java.lang.Boolean`	`canBeUpdated(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Determine if a customer accounts receivable can be updated.
`abstract java.lang.Boolean`	`canBeWrittenOff(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Determine if a customer accounts receivable can be written off.
`abstract void`	`changeParentAccountOfAGroup(com.crm.dataobject.accounts.CRMDOAccountReceivable newParentAccountReceivable, com.crm.dataobject.accounts.CRMDOAccountReceivable oldParentAccountReceivable)` Change Parent Accounts Receivable of an account group Loads all members of the old parent account and updates their parent
`abstract void`	`changeParentAccountOfAGroup(com.crm.dataobject.accounts.CRMDOAccountReceivable newParentAccountReceivable, com.crm.dataobject.accounts.CRMDOAccountReceivable oldParentAccountReceivable, java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableMember> members)` Change Parent Accounts Receivable of an account group
`void`	`closePeriod(java.lang.String accountReceivableID, java.lang.String accountReceivableNumber, java.math.BigDecimal openingBalance, com.crm.dataobject.accounts.CRMDOAccountingPeriod openAccountingPeriod, com.crm.dataobject.accounts.CRMDOAccountingPeriod newAccountingPeriod, java.util.Date closedDate)` Closes the Accounting Period for the Accounts Receivable
`abstract com.crm.dataobject.billing.CRMDOUsageAllowanceLimit`	`createUsageAllowanceLimit(com.crm.dataobject.billing.CRMDOUsageAllowanceLimit usageAllowanceLimit)` Create Usage Allowance Limit
`abstract com.crm.dataobject.billing.CRMDOUsageAllowanceLimit`	`getUsageAllowanceLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Returns usage allowance limit for an account receivable.
`abstract com.crm.dataobject.accounts.AutomaticRecurringPaymentAutoTopUpRule`	`getValidWalletTopUpRule(com.crm.dataobject.accounts.CRMDOAccountDefinition accountDefinition, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Returns a valid auto top up rule
`com.crm.dataobject.contactinfo.CRMDOContactInfoAddress`	`identifyBillingLocation(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Sets a primary account.
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivable`	`initialize(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Initializes the Accounts Receivable with default values when needed.
`abstract java.lang.Boolean`	`isAccessible(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Determines if a Accounts Receivable is retrievable.
`abstract java.lang.Boolean`	`isAccountMemberAccessible(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accounts.CRMDOAccountReceivableMember accountReceivableMember)` Determine if an accounts receivable member is accessible.
`abstract java.lang.Boolean`	`isActivePaymentPreferenceAccessible(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accounts.CRMDOAccountPaymentPreference accountPaymentPreference)` Determine if an active payment preference is accessible.
`abstract java.lang.Boolean`	`isActivePresentmentPreferenceAccessible(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference accountPresentmentPreference)` Determine if an active payment preference is accessible.
`abstract java.lang.Boolean`	`isBillingAddressAccessible(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Determine if a billing address is accessible.
`abstract java.lang.Boolean`	`isCreditLimitExceeded(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Determine if a accounts receivable credit limit is exceeded.
`abstract java.lang.Boolean`	`isFundedServiceAccessible(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accounts.CRMDOAccountReceivableMemberProduct accountReceivableMemberProduct)` Determine if an accounts receivable funded services is accessible.
`abstract java.lang.Boolean`	`isInactivePaymentPreferenceAccessible(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accounts.CRMDOAccountPaymentPreference accountPaymentPreference)` Determine if an inactive payment preference is accessible.
`abstract java.lang.Boolean`	`isInactivePresentmentPreferenceAccessible(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference accountPresentmentPreference)` Determine if an inactive presentment preference is accessible.
`abstract java.lang.Boolean`	`isUsageAllowanceLimitAccessible(com.crm.dataobject.billing.CRMDOUsageAllowanceLimit usageAllowanceLimit)` Determine if a usage allowance limit is accessible.
`abstract java.lang.Boolean`	`isUsageAllowanceLimitsPerServiceAccessible(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.billing.CRMDOUsageAllowanceLimitProduct usageAllowanceLimitProduct)` Determine if a usage allowance limit per service is accessible.
`java.lang.Boolean`	`isUsedByGroupOrUnit(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Determines if an Accounts Receivable is used by partner group or unit.
`abstract java.util.ArrayList<com.crm.dataobject.accesstokens.CRMDOAccessToken>`	`listAccessTokens(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` List Access Tokens.
`abstract java.util.ArrayList<com.crm.dataobject.accesstokens.CRMDOAccessToken>`	`listAccessTokens(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<java.lang.String> associations)` List Access Tokens.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableMemberProduct>`	`listAccountGroupMemberFundedServices(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` List Accounts Receivable Funded Services.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableMemberProduct>`	`listAccountGroupMemberFundedServices(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<java.lang.String> associations)` List Accounts Receivable Funded Services.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableMemberProduct>`	`listAccountGroupMemberFundedServices(com.crm.dataobject.accounts.CRMDOAccountReceivableMember accountReceivableMember)` List Accounts Receivable Funded Services.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableMemberProduct>`	`listAccountGroupMemberFundedServices(com.crm.dataobject.accounts.CRMDOAccountReceivableMember accountReceivableMember, java.util.ArrayList<java.lang.String> associations)` List Accounts Receivable Funded Services.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableMember>`	`listAccountGroupMembers(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` List Account Group Members.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableMember>`	`listAccountGroupMembers(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accounts.AccountReceivableMemberFundingScope fundingScope, java.lang.Integer numberOfResults, java.lang.Integer offSet)` List Account Group Members.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableMember>`	`listAccountGroupMembers(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<java.lang.String> associations)` List Account Group Members.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPaymentPreference>`	`listActivePaymentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Lists Account Payment Preference objects based on the given account.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPaymentPreference>`	`listActivePaymentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<java.lang.String> associations)` Lists Account Payment Preference objects based on the given account.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference>`	`listActivePresentmentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Lists Account Presentment Preference objects based on the given account.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference>`	`listActivePresentmentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<java.lang.String> associations)` Lists Account Presentment Preference objects based on the given account.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableAllowedWalletTopUpProduct>`	`listAllowedWalletTopUpProducts(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` List Allowed Wallet Top Up Products by account receivable.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableAllowedWalletTopUpProduct>`	`listAllowedWalletTopUpProducts(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<java.lang.String> associations)` List Allowed Wallet Top Up Products by account receivable.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPaymentPreference>`	`listInactivePaymentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Lists Account Payment Preference objects based on the given account.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPaymentPreference>`	`listInactivePaymentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<java.lang.String> associations)` Lists Account Payment Preference objects based on the given account.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference>`	`listInactivePresentmentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Lists Account Presentment Preference objects based on the given account.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference>`	`listInactivePresentmentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<java.lang.String> associations)` Lists Account Presentment Preference objects based on the given account.
`abstract java.util.ArrayList<com.crm.dataobject.paymentgateway.CRMDOPaymentGatewayCard>`	`listPaymentGatewayCards(com.crm.dataobject.accounts.CRMDOAccountPaymentPreference accountPaymentPreference)` List Payment Gateway Cards by Account Payment Preference.
`abstract java.util.ArrayList<com.crm.dataobject.paymentgateway.CRMDOPaymentGatewayCard>`	`listPaymentGatewayCards(com.crm.dataobject.accounts.CRMDOAccountPaymentPreference accountPaymentPreference, java.util.ArrayList<java.lang.String> associations)` List Payment Gateway Cards by Account Payment Preference.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPaymentPreference>`	`listPaymentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Lists Account Payment Preference objects based on the given account.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPaymentPreference>`	`listPaymentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<java.lang.String> associations)` Lists Account Payment Preference objects based on the given account.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPaymentPreference>`	`listPaymentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting, com.crm.dataobject.accounts.CRMDOAccountDefinition accountDefinition, java.util.ArrayList<java.lang.String> associations)` Lists Account Payment Preference objects based on the given account.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference>`	`listPresentmentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Lists Account Presentment Preference objects based on the given account.
`abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference>`	`listPresentmentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<java.lang.String> associations)` Lists Account Presentment Preference objects based on the given account.
`abstract java.util.ArrayList<com.crm.dataobject.billing.CRMDOUsageAllowanceLimitProduct>`	`listUsageAllowanceLimitsPerService(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` List Accounts Receivable Usage Allowance Limits per Service
`abstract java.util.ArrayList<com.crm.dataobject.billing.CRMDOUsageAllowanceLimitProduct>`	`listUsageAllowanceLimitsPerService(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<java.lang.String> associations)` List Accounts Receivable Usage Allowance Limits per Service
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivableAllowedWalletTopUpProduct`	`newAccountAllowedWalletTopUpProduct(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Instantiates and initializes a new account allowed wallet top up product.
`abstract com.crm.dataobject.accounts.CRMDOAccountPaymentPreference`	`newAccountPaymentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Instantiates and initializes a new account payment preference.
`abstract com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference`	`newAccountPresentmentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Instantiates and initializes a new account presentment preference.
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivable`	`newAccountReceivable()` Instantiates and initializes a new Accounts Receivable.
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivable`	`newAccountReceivable(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation)` Instantiates and initializes a new Accounts Receivable.
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivableMember`	`newAccountReceivableMember(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Instantiates and initializes a new account receivable member.
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivableMemberProduct`	`newAccountReceivableMemberProduct(com.crm.dataobject.accounts.CRMDOAccountReceivableMember accountReceivableMember)` Instantiates and initializes a new account receivable member product.
`abstract com.crm.dataobject.paymentgateway.CRMDOPaymentGatewayCard`	`newPaymentGatewayCard(com.crm.dataobject.accounts.CRMDOAccountPaymentPreference accountPaymentPreference)` Instantiates and initializes a new payment gateway card.
`abstract com.crm.dataobject.billing.CRMDOUsageAllowanceLimitProduct`	`newUsageAllowanceLimitProduct(com.crm.dataobject.billing.CRMDOUsageAllowanceLimit usageAllowanceLimit)` Instantiates and initializes a new usage allowance limit product.
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivable`	`read(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Reads an account receivable.
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivable`	`read(java.lang.String uniqueIdentifier)` Reads an account receivable by id.
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivable`	`read(java.lang.String uniqueIdentifier, java.util.ArrayList<java.lang.String> associations)` Reads an account receivable by id.
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivableMember`	`readAccountMember(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Reads an account receivable member by the member account receivable.
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivableMember`	`readAccountMember(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<java.lang.String> associations, java.util.ArrayList<java.lang.String> productAssociations)` Reads an account receivable member by the member account receivable.
`abstract com.crm.dataobject.accounts.CRMDOAccountPaymentPreference`	`readActivePaymentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.lang.String uniqueIdentifier)` Read an Active Payment Preference by id.
`abstract com.crm.dataobject.accounts.CRMDOAccountPaymentPreference`	`readActivePaymentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.lang.String uniqueIdentifier, java.util.ArrayList<java.lang.String> associations)` Read an Active Payment Preference by id.
`abstract com.crm.dataobject.accounts.CRMDOAccountPaymentPreference`	`readActivePaymentPreferenceByType(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accounts.PaymentPreferenceType type)` Read an Active Payment Preference by type.
`abstract com.crm.dataobject.accounts.CRMDOAccountPaymentPreference`	`readActivePaymentPreferenceByType(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accounts.PaymentPreferenceType type, java.util.ArrayList<java.lang.String> associations)` Read an Active Payment Preference by type.
`abstract com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference`	`readActivePresentmentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.lang.String uniqueIdentifier)` Read an Active Presentment Preference by id.
`abstract com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference`	`readActivePresentmentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.lang.String uniqueIdentifier, java.util.ArrayList<java.lang.String> associations)` Read an Active Presentment Preference by id.
`abstract com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference`	`readActivePresentmentPreferenceByType(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accounts.PresentmentMethod type)` Read an Active Presentment Preference by type.
`abstract com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference`	`readActivePresentmentPreferenceByType(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accounts.PresentmentMethod type, java.util.ArrayList<java.lang.String> associations)` Read an Active Presentment Preference by type.
`abstract com.crm.dataobject.contactinfo.CRMDOContactInfoAddress`	`readBillingAddress(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.lang.String uniqueIdentifier)` Reads a billing address by id.
`abstract com.crm.dataobject.contactinfo.CRMDOContactInfoAddress`	`readBillingAddress(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.lang.String uniqueIdentifier, java.util.ArrayList<java.lang.String> associations)` Reads a billing address by id.
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivable`	`readByName(java.lang.String uniqueIdentifier)` Reads an account receivable by name.
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivable`	`readByName(java.lang.String uniqueIdentifier, java.util.ArrayList<java.lang.String> associations)` Reads an account receivable by name.
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivable`	`readByNumber(java.lang.String uniqueIdentifier)` Reads an account receivable by number.
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivable`	`readByNumber(java.lang.String uniqueIdentifier, java.util.ArrayList<java.lang.String> associations)` Reads an account receivable by number.
`abstract com.crm.dataobject.accounts.CRMDOAccountPaymentPreference`	`readInactivePaymentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.lang.String uniqueIdentifier)` Read an Inactive Payment Preference by id.
`abstract com.crm.dataobject.accounts.CRMDOAccountPaymentPreference`	`readInactivePaymentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.lang.String uniqueIdentifier, java.util.ArrayList<java.lang.String> associations)` Read an Inactive Payment Preference by id.
`abstract com.crm.dataobject.accounts.CRMDOAccountPaymentPreference`	`readInactivePaymentPreferenceByType(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accounts.PaymentPreferenceType type)` Read an Inactive Payment Preference by type.
`abstract com.crm.dataobject.accounts.CRMDOAccountPaymentPreference`	`readInactivePaymentPreferenceByType(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accounts.PaymentPreferenceType type, java.util.ArrayList<java.lang.String> associations)` Read an Inactive Payment Preference by type.
`abstract com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference`	`readInactivePresentmentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.lang.String uniqueIdentifier)` Read an Inactive Presentment Preference by id.
`abstract com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference`	`readInactivePresentmentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.lang.String uniqueIdentifier, java.util.ArrayList<java.lang.String> associations)` Read an Inactive Presentment Preference by id.
`abstract com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference`	`readInactivePresentmentPreferenceByType(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accounts.PresentmentMethod type)` Read an Inactive Presentment Preference by type.
`abstract com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference`	`readInactivePresentmentPreferenceByType(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accounts.PresentmentMethod type, java.util.ArrayList<java.lang.String> associations)` Read an Inactive Presentment Preference by type.
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivable`	`readPrimary(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation)` Reads the primary account receivable of a contact.
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivable`	`readPrimary(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation, java.util.ArrayList<java.lang.String> associations)` Reads the primary account receivable of a contact.
`abstract com.crm.dataobject.billing.CRMDOUsageAllowanceLimit`	`readUsageAllowanceLimits(java.lang.String uniqueIdentifier)` Read Accounts Receivable Usage Allowance Limits
`abstract com.crm.dataobject.billing.CRMDOUsageAllowanceLimit`	`readUsageAllowanceLimits(java.lang.String uniqueIdentifier, java.util.ArrayList<java.lang.String> associations)` Read Accounts Receivable Usage Allowance Limits
`abstract com.crm.dataobject.billing.CRMDOUsageAllowanceLimit`	`readUsageAllowanceLimitsByAccount(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Read Accounts Receivable Usage Allowance Limits
`com.crm.dataobject.accounts.CRMDOAccountReceivable`	`removeMemberFromAGroup(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Remove Member Accounts Receivable from an account group
`void`	`resetAccountingPeriod(java.lang.String accountReceivableID, com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod)` Resets the Accounting Period for the Accounts Receivable given
`void`	`resetAccountingPeriodBalance(java.lang.String accountReceivableID, java.util.ArrayList<com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction> transactions, java.util.ArrayList<com.crm.dataobject.CRMDO> allAccountingPeriods, java.util.Date asOfDate)` Resets the Accounting Period Balance for the Accounts Receivable given
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivable`	`resetUsageAllowanceLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Removes the usage allowance limits of the given account receivable.
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivable`	`resetUsageAllowanceLimitBasedOnCurrency(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Reset the usage allowance limit for an account receivable based on the currency.
`abstract java.math.BigDecimal`	`revertAmountToDefaultCurrency(java.math.BigDecimal amount, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Revert amount to default currency
`com.crm.dataobject.accounts.CRMDOAccountReceivable`	`setAsPrimary(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Sets a primary account.
`com.crm.dataobject.contactinfo.CRMDOContactInformation`	`setContactInformationAddresses(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)`
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivable`	`setUpRecurringPaymentSettings(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Set up recurring payment settings
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivable`	`setUsageAllowanceLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Creates a usage allowance limit for an account receivable.
`com.crm.dataobject.accounts.CRMDOAccountReceivable`	`suspendAccount(com.crm.dataobject.accounts.CRMDOAccountReceivable account)` Suspends an account.
`com.crm.dataobject.accounts.CRMDOAccountReceivable`	`terminateAccount(com.crm.dataobject.accounts.CRMDOAccountReceivable account)` Terminates an account.
`com.crm.dataobject.financialtransactions.CRMDOInvoice`	`transferMoneyToWallet(com.crm.dataobject.wallets.CRMDOWalletDefinition walletDefinition, com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.math.BigDecimal amount)` Transfers money from an account to the account wallet Creates an invoice based on the On Transferring Money From Account To Wallet cause configured on active the wallet definition Creates a credit wallet transaction for the account wallet with the given amount and based on the On Transferring Money From Account To Wallet cause configured on active the wallet definition Posts the created invoice
`com.crm.dataobject.financialtransactions.CRMDOInvoice`	`transferMoneyToWallet(com.crm.dataobject.wallets.CRMDOWalletDefinition walletDefinition, com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.math.BigDecimal amount, com.crm.dataobject.wallets.CRMDOWallet wallet)` Transfers money from an account to the account wallet Creates a credit wallet transaction for the account wallet with the given amount and based on the On Transferring Money From Account To Wallet cause configured on active the wallet definition Creates an invoice based on WALLET RULES - CREDITING WALLETS - "Debit the Related Accounts Receivable due to transfer Money" configured on active the wallet definition
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivable`	`update(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Update Accounts Receivable
`void`	`updateAccountPaymentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Update the payment preferences of an account.
`void`	`updateAccountPresentmentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Update the presentment preferences of an account.
`com.crm.dataobject.accounts.CRMDOAccountReceivable`	`updateCreditLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.math.BigDecimal newCreditLimit, com.crm.dataobject.accounts.CreditRating newCreditRatingCode)` Update the credit limit of an account.
`com.crm.dataobject.accounts.CRMDOAccountReceivable`	`updateCreditPeriod(com.crm.dataobject.accounts.CRMDOAccountReceivable account, com.crm.dataobject.accounts.CreditPeriodOperator newCreditPeriodOperator, java.lang.Integer newCreditPeriod, com.crm.framework.util.UnitOfTime newCreditPeriodUOT)` Update the credit period of an account.
`com.crm.dataobject.accounts.CRMDOAccountReceivable`	`updateCreditTerms(com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.math.BigDecimal newCreditLimit, com.crm.dataobject.accounts.CreditRating newCreditRatingCode, com.crm.dataobject.accounts.CreditPeriodOperator newCreditPeriodOperator, java.lang.Integer newCreditPeriod)` Update the credit terms of an account.
`com.crm.dataobject.accounts.CRMDOAccountReceivable`	`updateCreditTerms(com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.math.BigDecimal newCreditLimit, com.crm.dataobject.accounts.CreditRating newCreditRatingCode, com.crm.dataobject.accounts.CreditPeriodOperator newCreditPeriodOperator, java.lang.Integer newCreditPeriod, com.crm.framework.util.UnitOfTime newCreditPeriodUOT)` Update the credit terms of an account.
`abstract com.crm.dataobject.accounts.CRMDOAccountReceivableMember`	updateMembershipInformation(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.accounts.AccountReceivableMemberFundingScope fundingScope, java.util.ArrayList<com.crm.dataobject.products.CRMDOProduct> products, java.util.ArrayList<com.crm.dataobject.products.CRMDOProductType> productTypes, java.util.ArrayList<com.crm.dataobject.products.CRMDOProductFamily> productFamilies, java.util.ArrayList<com.crm.dataobject.products.CRMDOProduct> removedProducts, java.util.ArrayList<com.crm.dataobject.products.CRMDOProductType> removedProductTypes, java.util.ArrayList<com.crm.dataobject.products.CRMDOProductFamily> removedProductFamilies) Update membership information of a member
`abstract com.crm.dataobject.billing.CRMDOUsageAllowanceLimit`	`updateUsageAllowanceLimit(com.crm.dataobject.billing.CRMDOUsageAllowanceLimit usageAllowanceLimit)` Update Usage Allowance Limit
`com.crm.dataobject.accounts.CRMDOAccountReceivable`	`writeOff(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)` Write off an account receivable.

Methods inherited from class com.crm.process.CRMProcess
createCronExpressionFromDate, createCronExpressionFromDate, setMandatoryField

Methods inherited from class com.crm.businessobject.CRMBase
deepCopy, dispatch, getCRMSession, getCRMSessionHandle, getCurrentDate, getEJBHomeInterface, getInitialContext, getSessionContext, invoke, loadEntityCategories, loadEntityNumber, loadEntityStates, loadEntityStatuses, loadEntityTypes, rollback, setCRMSessionHandle, setInitialContext, setSessionContext

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- CRMProcessNonSystemAccountReceivableBean
```
public CRMProcessNonSystemAccountReceivableBean()
```
  Default constructor.

Method Detail

newAccountReceivable

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivable newAccountReceivable()
                                                                                 throws java.lang.Exception

Instantiates and initializes a new Accounts Receivable.

Returns:: the Accounts Receivable
Throws:: java.lang.Exception

newAccountReceivable

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivable newAccountReceivable(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation)
                                                                                 throws java.lang.Exception

Instantiates and initializes a new Accounts Receivable.

Parameters:: contactInformation - - the Contact Information for which the account will be created(optional)
Returns:: the Accounts Receivable
Throws:: java.lang.Exception

update

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivable update(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                   throws java.lang.Exception

Update Accounts Receivable

Parameters:: accountReceivable - - the account receivable to update(mandatory)
Returns:: the updated Accounts Receivable
Throws:: java.lang.Exception

applyCommonOperations

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivable applyCommonOperations(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                  throws java.lang.Exception

Executes the common operations of the Account Receivable.

Parameters:: accountReceivable - - the Account Receivable for which common operations will be executed(mandatory)
Returns:: the updated Account Receivable
Throws:: java.lang.Exception

initialize

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivable initialize(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                       throws java.lang.Exception

Initializes the Accounts Receivable with default values when needed.

Parameters:: accountReceivable - - the Accounts Receivable to initialize(mandatory)
Returns:: the updated Accounts Receivable
Throws:: java.lang.Exception

isAccessible
```
public abstract java.lang.Boolean isAccessible(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                        throws java.lang.Exception
```
Determines if a Accounts Receivable is retrievable.

Parameters:

accountReceivable - - the Accounts Receivable to determine whether it is accessible or not(mandatory)

Returns:

true if the given Accounts Receivable is accessible, otherwise false

Throws:

java.lang.Exception

isCreditLimitExceeded
```
public abstract java.lang.Boolean isCreditLimitExceeded(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                 throws java.lang.Exception
```
Determine if a accounts receivable credit limit is exceeded.

Parameters:

accountReceivable - - the Accounts Receivable to determine whether credit limit is exceeded or not(mandatory)

Returns:

true if the given Accounts' Receivable credit limit is exceeded, otherwise false

Throws:

java.lang.Exception

isBillingAddressAccessible
```
public abstract java.lang.Boolean isBillingAddressAccessible(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                      throws java.lang.Exception
```
Determine if a billing address is accessible.

Parameters:

accountReceivable - - the Accounts Receivable to determine whether the billing address it is accessible or not(mandatory)

Returns:

true if the given Accounts' Receivable billing address is accessible, otherwise false

Throws:

java.lang.Exception

isActivePaymentPreferenceAccessible

public abstract java.lang.Boolean isActivePaymentPreferenceAccessible(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                      com.crm.dataobject.accounts.CRMDOAccountPaymentPreference accountPaymentPreference)
                                                               throws java.lang.Exception

Determine if an active payment preference is accessible.

Parameters:: accountReceivable - - the account receivable(mandatory); accountPaymentPreference - - the active account payment preference to determine whether is accessible or not(mandatory)
Returns:: true if the given active payment preference is accessible, otherwise false
Throws:: java.lang.Exception

isInactivePaymentPreferenceAccessible

public abstract java.lang.Boolean isInactivePaymentPreferenceAccessible(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                        com.crm.dataobject.accounts.CRMDOAccountPaymentPreference accountPaymentPreference)
                                                                 throws java.lang.Exception

Determine if an inactive payment preference is accessible.

Parameters:: accountReceivable - - the account receivable(mandatory); accountPaymentPreference - - the inactive account payment preference to determine whether is accessible or not(mandatory)
Returns:: true if the given inactive payment preference is accessible, otherwise false
Throws:: java.lang.Exception

isActivePresentmentPreferenceAccessible

public abstract java.lang.Boolean isActivePresentmentPreferenceAccessible(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                          com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference accountPresentmentPreference)
                                                                   throws java.lang.Exception

Determine if an active payment preference is accessible.

Parameters:: accountReceivable - - the account receivable(mandatory); accountPresentmentPreference - - the active account presentment preference to determine whether is accessible or not(mandatory)
Returns:: true if the given active presentment preference is accessible, otherwise false
Throws:: java.lang.Exception

isInactivePresentmentPreferenceAccessible

public abstract java.lang.Boolean isInactivePresentmentPreferenceAccessible(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                            com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference accountPresentmentPreference)
                                                                     throws java.lang.Exception

Determine if an inactive presentment preference is accessible.

Parameters:: accountReceivable - - the account receivable(mandatory); accountPresentmentPreference - - the inactive account presentment preference to determine whether is accessible or not(mandatory)
Returns:: true if the given inactive presentment preference is accessible, otherwise false
Throws:: java.lang.Exception

isFundedServiceAccessible
```
public abstract java.lang.Boolean isFundedServiceAccessible(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                            com.crm.dataobject.accounts.CRMDOAccountReceivableMemberProduct accountReceivableMemberProduct)
                                                     throws java.lang.Exception
```
Determine if an accounts receivable funded services is accessible.

Parameters:

accountReceivable - - the account receivable(mandatory)

accountReceivableMemberProduct - - the active accounts receivable funded service to determine whether is accessible or not(mandatory)

Returns:

true if the given accounts receivable funded service is accessible, otherwise false

Throws:

java.lang.Exception

isUsageAllowanceLimitAccessible
```
public abstract java.lang.Boolean isUsageAllowanceLimitAccessible(com.crm.dataobject.billing.CRMDOUsageAllowanceLimit usageAllowanceLimit)
                                                           throws java.lang.Exception
```
Determine if a usage allowance limit is accessible.

Parameters:

usageAllowanceLimit - - the usage allowance limit to determine whether is accessible or not(mandatory)

Returns:

true if the given usage allowance limit is accessible, otherwise false

Throws:

java.lang.Exception

isUsageAllowanceLimitsPerServiceAccessible

public abstract java.lang.Boolean isUsageAllowanceLimitsPerServiceAccessible(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                             com.crm.dataobject.billing.CRMDOUsageAllowanceLimitProduct usageAllowanceLimitProduct)
                                                                      throws java.lang.Exception

Determine if a usage allowance limit per service is accessible.

Parameters:: accountReceivable - - the account receivable(mandatory); usageAllowanceLimitProduct - - the usage allowance limit per service to determine whether is accessible or not(mandatory)
Returns:: true if the given usage allowance limit product is accessible, otherwise false
Throws:: java.lang.Exception

canBeActivated
```
public abstract java.lang.Boolean canBeActivated(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                          throws java.lang.Exception
```
Determine if a customer accounts receivable can be activated.

Parameters:

accountReceivable - - the account receivable to determine if it can be activated(mandatory)

Returns:

true if the given account receivable can be activated, otherwise false

Throws:

java.lang.Exception

canBeSuspended
```
public abstract java.lang.Boolean canBeSuspended(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                          throws java.lang.Exception
```
Determine if a customer accounts receivable can be suspended.

Parameters:

accountReceivable - - the account receivable to determine if it can be suspended(mandatory)

Returns:

true if the given account receivable can be suspended, otherwise false

Throws:

java.lang.Exception

canBeTerminated
```
public abstract java.lang.Boolean canBeTerminated(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                           throws java.lang.Exception
```
Determine if a customer accounts receivable can be terminated.

Parameters:

accountReceivable - - the account receivable to determine if it can be terminated(mandatory)

Returns:

true if the given account receivable can be terminated, otherwise false

Throws:

java.lang.Exception

canBeUpdated
```
public abstract java.lang.Boolean canBeUpdated(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                        throws java.lang.Exception
```
Determine if a customer accounts receivable can be updated.

Parameters:

accountReceivable - - the account receivable to determine if it can be updated(mandatory)

Returns:

true if the given account receivable can be updated, otherwise false

Throws:

java.lang.Exception

canBeWrittenOff
```
public abstract java.lang.Boolean canBeWrittenOff(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                           throws java.lang.Exception
```
Determine if a customer accounts receivable can be written off.

Parameters:

accountReceivable - - the account receivable to determine if it can be written off(mandatory)

Returns:

true if the given account receivable can be written off, otherwise false

Throws:

java.lang.Exception

applyOnEntity

public abstract com.crm.dataobject.CRMDO applyOnEntity(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                       com.crm.dataobject.CRMDO crmdo)
                                                throws java.lang.Exception

Associates an Accounts Receivable to a account based entity.

Parameters:: accountReceivable - - the Accounts Receivable to associate to an entity(mandatory); crmdo - - the entity to relate the account with(mandatory)
Returns:: the updated entity
Throws:: java.lang.Exception

read

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivable read(java.lang.String uniqueIdentifier)
                                                                 throws java.lang.Exception

Reads an account receivable by id.

Parameters:: uniqueIdentifier - - the account receivable unique identifier(mandatory)
Returns:: the account receivable
Throws:: java.lang.Exception

read

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivable read(java.lang.String uniqueIdentifier,
                                                                        java.util.ArrayList<java.lang.String> associations)
                                                                 throws java.lang.Exception

Reads an account receivable by id.

Parameters:: uniqueIdentifier - - the account receivable unique identifier(mandatory); associations - - a list of associations(optional)
Returns:: the account receivable
Throws:: java.lang.Exception

readByName

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivable readByName(java.lang.String uniqueIdentifier)
                                                                       throws java.lang.Exception

Reads an account receivable by name.

Parameters:: uniqueIdentifier - - the account receivable unique identifier(mandatory)
Returns:: the account receivable
Throws:: java.lang.Exception

readByName

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivable readByName(java.lang.String uniqueIdentifier,
                                                                              java.util.ArrayList<java.lang.String> associations)
                                                                       throws java.lang.Exception

Reads an account receivable by name.

Parameters:: uniqueIdentifier - - the account receivable unique identifier(mandatory); associations - - a list of associations(optional)
Returns:: the account receivable
Throws:: java.lang.Exception

readByNumber

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivable readByNumber(java.lang.String uniqueIdentifier)
                                                                         throws java.lang.Exception

Reads an account receivable by number.

Parameters:: uniqueIdentifier - - the account receivable unique identifier(mandatory)
Returns:: the account receivable
Throws:: java.lang.Exception

readByNumber

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivable readByNumber(java.lang.String uniqueIdentifier,
                                                                                java.util.ArrayList<java.lang.String> associations)
                                                                         throws java.lang.Exception

Reads an account receivable by number.

Parameters:: uniqueIdentifier - - the account receivable unique identifier(mandatory); associations - - a list of associations(optional)
Returns:: the account receivable
Throws:: java.lang.Exception

readPrimary

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivable readPrimary(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation)
                                                                        throws java.lang.Exception

Reads the primary account receivable of a contact.

Parameters:: contactInformation - - the contact to load the primary account receivable
Returns:: the primary account receivable
Throws:: java.lang.Exception

readPrimary

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivable readPrimary(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation,
                                                                               java.util.ArrayList<java.lang.String> associations)
                                                                        throws java.lang.Exception

Reads the primary account receivable of a contact.

Parameters:: contactInformation - - the contact to load the primary account receivable; associations - - a list of associations(optional)
Returns:: the primary account receivable
Throws:: java.lang.Exception

read

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivable read(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                 throws java.lang.Exception

Reads an account receivable.

Parameters:: accountReceivable - - the account receivable(mandatory)
Returns:: the account receivable
Throws:: java.lang.Exception; com.crm.exception.CannotAccessEntityException

writeOff

public com.crm.dataobject.accounts.CRMDOAccountReceivable writeOff(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                            throws java.lang.Exception,
                                                                   com.crm.exception.CannotAccessEntityException,
                                                                   com.crm.exception.accounts.CannotWriteOffAccountException

Write off an account receivable.

Parameters:: accountReceivable - - the account receivable to write off(mandatory)
Returns:: the write off Customer Accounts Receivable
Throws:: java.lang.Exception; com.crm.exception.CannotAccessEntityException; com.crm.exception.accounts.CannotWriteOffAccountException

calculateOutstandingAmount
```
public java.math.BigDecimal calculateOutstandingAmount(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                throws java.lang.Exception
```
Calculate the outstanding amount for an account.

Parameters:

accountReceivable - - the account to return the outstanding amount for

Returns:

the outstanding amount for the account

Throws:

java.lang.Exception

calculateOutstandingAmount
```
public java.math.BigDecimal calculateOutstandingAmount(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                       java.util.Date asOfDate)
                                                throws java.lang.Exception
```
Calculate the outstanding amount for an account.

Parameters:

accountReceivable - - the account to return the outstanding amount for

asOfDate - - the as of date to return the outstanding amount

Returns:

the outstanding amount for the account

Throws:

java.lang.Exception

calculateBalance
```
public java.math.BigDecimal calculateBalance(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                      throws java.lang.Exception
```
Calculate the balance for an account.

Parameters:

accountReceivable - - the account to return the outstanding amount for

Returns:

the balance for the account

Throws:

java.lang.Exception

calculateBalance

public java.math.BigDecimal calculateBalance(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                             java.util.Date asOfDate)
                                      throws java.lang.Exception

Calculate the balance for an account.

Parameters:: accountReceivable - - the account to return the balance for; asOfDate - - the as of date to return the balance
Returns:: the balance for the account
Throws:: java.lang.Exception

calculateCreditLimitStatus

public com.crm.dataobject.accounts.CreditLimitStatus calculateCreditLimitStatus(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                         throws java.lang.Exception

Calculate the credit limit status for an account.

Parameters:: accountReceivable - - the account to return the credit limit status for
Returns:: the credit limit status for the account
Throws:: java.lang.Exception

updateCreditLimit

public com.crm.dataobject.accounts.CRMDOAccountReceivable updateCreditLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                                            java.math.BigDecimal newCreditLimit,
                                                                            com.crm.dataobject.accounts.CreditRating newCreditRatingCode)
                                                                     throws java.lang.Exception

Update the credit limit of an account.

Parameters:: account - - the account to change the credit limit for; newCreditLimit - - the credit limit to set; newCreditRatingCode - - the credit rating code to set
Returns:: the updated account
Throws:: java.lang.Exception

updateCreditPeriod

public com.crm.dataobject.accounts.CRMDOAccountReceivable updateCreditPeriod(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                                             com.crm.dataobject.accounts.CreditPeriodOperator newCreditPeriodOperator,
                                                                             java.lang.Integer newCreditPeriod,
                                                                             com.crm.framework.util.UnitOfTime newCreditPeriodUOT)
                                                                      throws java.lang.Exception

Update the credit period of an account.

Parameters:: account - - the account to set the credit period for; newCreditPeriodOperator - - the credit period operator to set; newCreditPeriod - - the credit period to set
Returns:: the updated account
Throws:: java.lang.Exception

applyCreditPeriodRules

public java.util.Date applyCreditPeriodRules(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                             com.crm.dataobject.accounts.CRMDOAccountDefinition accountDefinition,
                                             java.util.Date postedDate)
                                      throws java.lang.Exception

Calculates a date based on credit period rules.

Parameters:: accountReceivable - - the account receivable to get the information from; accountDefinition - - the account definition to get the information from; postedDate - - the posted date to apply the changes
Returns:: the calculated date
Throws:: java.lang.Exception

calculateConsumedUsageAllowance

public com.crm.dataobject.accounts.CRMDOAccountReceivable calculateConsumedUsageAllowance(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                          java.util.Date validityDate,
                                                                                          com.crm.dataobject.billing.CRMDOUsageAuthorisation usageAuthorisation)
                                                                                   throws java.lang.Exception

Calculate Consumed Usage Allowance.

Parameters:: accountReceivable - - the account receivable to calculate the consumed usage allowance; validityDate - - the date to calculate the consumed usage allowance; usageAuthorisation - - the usage authorisation to exclude
Returns:: the updated account
Throws:: java.lang.Exception

calculateRemainingUsageAllowance

public com.crm.dataobject.accounts.CRMDOAccountReceivable calculateRemainingUsageAllowance(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                           java.util.Date validityDate,
                                                                                           com.crm.dataobject.billing.CRMDOUsageAuthorisation usageAuthorisation)
                                                                                    throws java.lang.Exception

Calculate Consumed Usage Allowance.

Parameters:: accountReceivable - - the account receivable to calculate the remaining usage allowance; validityDate - - the date to calculate the remaining usage allowance; usageAuthorisation - - the usage authorisation to exclude
Returns:: the updated account
Throws:: java.lang.Exception

calculateAllowedExceededUsageAllowance

public java.math.BigDecimal calculateAllowedExceededUsageAllowance(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                   java.util.Date validityDate,
                                                                   com.crm.dataobject.billing.CRMDOUsageAuthorisation usageAuthorisation)
                                                            throws java.lang.Exception

Calculate allowed exceeded Usage Allowance.

Parameters:: accountReceivable - - the account receivable to calculate the allowed exceeded usage allowance; validityDate - - the date to calculate the allowed exceeded usage allowance; usageAuthorisation - - the usage authorisation to exclude
Returns:: the allowed exceeded usage allowance
Throws:: java.lang.Exception

readBillingAddress

public abstract com.crm.dataobject.contactinfo.CRMDOContactInfoAddress readBillingAddress(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                          java.lang.String uniqueIdentifier)
                                                                                   throws java.lang.Exception

Reads a billing address by id.

Parameters:: accountReceivable - - the account receivable(mandatory); uniqueIdentifier - - the contact info address unique identifier(mandatory)
Returns:: the billing address
Throws:: java.lang.Exception

readBillingAddress

public abstract com.crm.dataobject.contactinfo.CRMDOContactInfoAddress readBillingAddress(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                          java.lang.String uniqueIdentifier,
                                                                                          java.util.ArrayList<java.lang.String> associations)
                                                                                   throws java.lang.Exception

Reads a billing address by id.

Parameters:: accountReceivable - - the account receivable(mandatory); uniqueIdentifier - - the contact info address unique identifier(mandatory); associations - - a list of associations(optional)
Returns:: the billing address
Throws:: java.lang.Exception

readActivePaymentPreference

public abstract com.crm.dataobject.accounts.CRMDOAccountPaymentPreference readActivePaymentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                      java.lang.String uniqueIdentifier)
                                                                                               throws java.lang.Exception

Read an Active Payment Preference by id.

Parameters:: accountReceivable - - the account receivable(mandatory); uniqueIdentifier - - the account payment preference unique identifier(mandatory)
Returns:: the active payment preference
Throws:: java.lang.Exception

readActivePaymentPreference

public abstract com.crm.dataobject.accounts.CRMDOAccountPaymentPreference readActivePaymentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                      java.lang.String uniqueIdentifier,
                                                                                                      java.util.ArrayList<java.lang.String> associations)
                                                                                               throws java.lang.Exception

Read an Active Payment Preference by id.

Parameters:: accountReceivable - - the account receivable(mandatory); uniqueIdentifier - - the account payment preference unique identifier(mandatory); associations - - a list of associations(optional)
Returns:: the active payment preference
Throws:: java.lang.Exception

readActivePaymentPreferenceByType

public abstract com.crm.dataobject.accounts.CRMDOAccountPaymentPreference readActivePaymentPreferenceByType(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                            com.crm.dataobject.accounts.PaymentPreferenceType type)
                                                                                                     throws java.lang.Exception

Read an Active Payment Preference by type.

Parameters:: accountReceivable - - the account receivable(mandatory); type - - the payment preference type(mandatory)
Returns:: the active payment preference
Throws:: java.lang.Exception

readActivePaymentPreferenceByType

public abstract com.crm.dataobject.accounts.CRMDOAccountPaymentPreference readActivePaymentPreferenceByType(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                            com.crm.dataobject.accounts.PaymentPreferenceType type,
                                                                                                            java.util.ArrayList<java.lang.String> associations)
                                                                                                     throws java.lang.Exception

Read an Active Payment Preference by type.

Parameters:: accountReceivable - - the account receivable(mandatory); type - - the payment preference type(mandatory); associations - - a list of associations(optional)
Returns:: the active payment preference
Throws:: java.lang.Exception

listActivePaymentPreferences

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPaymentPreference> listActivePaymentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                                                     throws java.lang.Exception

Lists Account Payment Preference objects based on the given account.

Parameters:: accountReceivable - - the criteria that will be used to load the Account Payment Preference objects(mandatory)
Returns:: a list of active account Payment Preferences of the given account
Throws:: java.lang.Exception

listActivePaymentPreferences

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPaymentPreference> listActivePaymentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                            java.util.ArrayList<java.lang.String> associations)
                                                                                                                     throws java.lang.Exception

Lists Account Payment Preference objects based on the given account.

Parameters:: accountReceivable - - the criteria that will be used to load the Account Payment Preference objects(mandatory); associations - - a list of associations(optional)
Returns:: a list of active account Payment Preferences of the given account
Throws:: java.lang.Exception

readInactivePaymentPreference

public abstract com.crm.dataobject.accounts.CRMDOAccountPaymentPreference readInactivePaymentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                        java.lang.String uniqueIdentifier)
                                                                                                 throws java.lang.Exception

Read an Inactive Payment Preference by id.

Parameters:: accountReceivable - - the account receivable(mandatory); uniqueIdentifier - - the account payment preference unique identifier(mandatory)
Returns:: the active payment preference
Throws:: java.lang.Exception

readInactivePaymentPreference

public abstract com.crm.dataobject.accounts.CRMDOAccountPaymentPreference readInactivePaymentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                        java.lang.String uniqueIdentifier,
                                                                                                        java.util.ArrayList<java.lang.String> associations)
                                                                                                 throws java.lang.Exception

Read an Inactive Payment Preference by id.

Parameters:: accountReceivable - - the account receivable(mandatory); uniqueIdentifier - - the account payment preference unique identifier(mandatory); associations - - a list of associations(optional)
Returns:: the inactive payment preference
Throws:: java.lang.Exception

readInactivePaymentPreferenceByType

public abstract com.crm.dataobject.accounts.CRMDOAccountPaymentPreference readInactivePaymentPreferenceByType(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                              com.crm.dataobject.accounts.PaymentPreferenceType type)
                                                                                                       throws java.lang.Exception

Read an Inactive Payment Preference by type.

Parameters:: accountReceivable - - the account receivable(mandatory); type - - the payment preference type(mandatory)
Returns:: the inactive payment preference
Throws:: java.lang.Exception

readInactivePaymentPreferenceByType

public abstract com.crm.dataobject.accounts.CRMDOAccountPaymentPreference readInactivePaymentPreferenceByType(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                              com.crm.dataobject.accounts.PaymentPreferenceType type,
                                                                                                              java.util.ArrayList<java.lang.String> associations)
                                                                                                       throws java.lang.Exception

Read an Inactive Payment Preference by type.

Parameters:: accountReceivable - - the account receivable(mandatory); type - - the payment preference type(mandatory); associations - - a list of associations(optional)
Returns:: the inactive payment preference
Throws:: java.lang.Exception

listInactivePaymentPreferences

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPaymentPreference> listInactivePaymentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                                                       throws java.lang.Exception

Lists Account Payment Preference objects based on the given account.

Parameters:: accountReceivable - - the criteria that will be used to load the Account Payment Preference objects(mandatory)
Returns:: a list of inactive account Payment Preferences of the given account
Throws:: java.lang.Exception

listInactivePaymentPreferences

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPaymentPreference> listInactivePaymentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                              java.util.ArrayList<java.lang.String> associations)
                                                                                                                       throws java.lang.Exception

Lists Account Payment Preference objects based on the given account.

Parameters:: accountReceivable - - the criteria that will be used to load the Account Payment Preference objects(mandatory); associations - - a list of associations(optional)
Returns:: a list of inactive account Payment Preferences of the given account
Throws:: java.lang.Exception

listPaymentPreferences

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPaymentPreference> listPaymentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                                               throws java.lang.Exception

Lists Account Payment Preference objects based on the given account.

Parameters:: accountReceivable - - the criteria that will be used to load the Account Payment Preference objects(mandatory)
Returns:: a list of account Payment Preferences of the given account
Throws:: java.lang.Exception

listPaymentPreferences

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPaymentPreference> listPaymentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                      java.util.ArrayList<java.lang.String> associations)
                                                                                                               throws java.lang.Exception

Lists Account Payment Preference objects based on the given account.

Parameters:: accountReceivable - - the criteria that will be used to load the Account Payment Preference objects(mandatory); associations - - a list of associations(optional)
Returns:: a list of account Payment Preferences of the given account
Throws:: java.lang.Exception

readActivePresentmentPreference

public abstract com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference readActivePresentmentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                              java.lang.String uniqueIdentifier)
                                                                                                       throws java.lang.Exception

Read an Active Presentment Preference by id.

Parameters:: accountReceivable - - the account receivable(mandatory); uniqueIdentifier - - the account presentment preference unique identifier(mandatory)
Returns:: the active presentment preference
Throws:: java.lang.Exception

readActivePresentmentPreference

public abstract com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference readActivePresentmentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                              java.lang.String uniqueIdentifier,
                                                                                                              java.util.ArrayList<java.lang.String> associations)
                                                                                                       throws java.lang.Exception

Read an Active Presentment Preference by id.

Parameters:: accountReceivable - - the account receivable(mandatory); uniqueIdentifier - - the account presentment preference unique identifier(mandatory); associations - - a list of associations(optional)
Returns:: the active presentment preference
Throws:: java.lang.Exception

readActivePresentmentPreferenceByType

public abstract com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference readActivePresentmentPreferenceByType(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                    com.crm.dataobject.accounts.PresentmentMethod type)
                                                                                                             throws java.lang.Exception

Read an Active Presentment Preference by type.

Parameters:: accountReceivable - - the account receivable(mandatory); type - - the presentment preference type(mandatory)
Returns:: the active presentment preference
Throws:: java.lang.Exception

readActivePresentmentPreferenceByType

public abstract com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference readActivePresentmentPreferenceByType(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                    com.crm.dataobject.accounts.PresentmentMethod type,
                                                                                                                    java.util.ArrayList<java.lang.String> associations)
                                                                                                             throws java.lang.Exception

Read an Active Presentment Preference by type.

Parameters:: accountReceivable - - the account receivable(mandatory); type - - the presentment preference type(mandatory); associations - - a list of associations(optional)
Returns:: the active presentment preference
Throws:: java.lang.Exception

listActivePresentmentPreferences

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference> listActivePresentmentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                                                             throws java.lang.Exception

Lists Account Presentment Preference objects based on the given account.

Parameters:: accountReceivable - - the criteria that will be used to load the Account Presentment Preference objects(mandatory)
Returns:: a list of active account Presentment Preferences of the given account
Throws:: java.lang.Exception

listActivePresentmentPreferences

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference> listActivePresentmentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                                    java.util.ArrayList<java.lang.String> associations)
                                                                                                                             throws java.lang.Exception

Lists Account Presentment Preference objects based on the given account.

Parameters:: accountReceivable - - the criteria that will be used to load the Account Presentment Preference objects(mandatory); associations - - a list of associations(optional)
Returns:: a list of active account Presentment Preferences of the given account
Throws:: java.lang.Exception

readInactivePresentmentPreference

public abstract com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference readInactivePresentmentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                java.lang.String uniqueIdentifier)
                                                                                                         throws java.lang.Exception

Read an Inactive Presentment Preference by id.

Parameters:: accountReceivable - - the account receivable(mandatory); uniqueIdentifier - - the account presentment preference unique identifier(mandatory)
Returns:: the active presentment preference
Throws:: java.lang.Exception

readInactivePresentmentPreference

public abstract com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference readInactivePresentmentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                java.lang.String uniqueIdentifier,
                                                                                                                java.util.ArrayList<java.lang.String> associations)
                                                                                                         throws java.lang.Exception

Read an Inactive Presentment Preference by id.

Parameters:: accountReceivable - - the account receivable(mandatory); uniqueIdentifier - - the account presentment preference unique identifier(mandatory); associations - - a list of associations(optional)
Returns:: the inactive presentment preference
Throws:: java.lang.Exception

readInactivePresentmentPreferenceByType

public abstract com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference readInactivePresentmentPreferenceByType(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                      com.crm.dataobject.accounts.PresentmentMethod type)
                                                                                                               throws java.lang.Exception

Read an Inactive Presentment Preference by type.

Parameters:: accountReceivable - - the account receivable(mandatory); type - - the presentment preference type(mandatory)
Returns:: the inactive presentment preference
Throws:: java.lang.Exception

readInactivePresentmentPreferenceByType

public abstract com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference readInactivePresentmentPreferenceByType(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                      com.crm.dataobject.accounts.PresentmentMethod type,
                                                                                                                      java.util.ArrayList<java.lang.String> associations)
                                                                                                               throws java.lang.Exception

Read an Inactive Presentment Preference by type.

Parameters:: accountReceivable - - the account receivable(mandatory); type - - the presentment preference type(mandatory); associations - - a list of associations(optional)
Returns:: the inactive presentment preference
Throws:: java.lang.Exception

listInactivePresentmentPreferences

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference> listInactivePresentmentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                                                               throws java.lang.Exception

Lists Account Presentment Preference objects based on the given account.

Parameters:: accountReceivable - - the criteria that will be used to load the Account Presentment Preference objects(mandatory)
Returns:: a list of inactive account Presentment Preferences of the given account
Throws:: java.lang.Exception

listInactivePresentmentPreferences

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference> listInactivePresentmentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                                      java.util.ArrayList<java.lang.String> associations)
                                                                                                                               throws java.lang.Exception

Lists Account Presentment Preference objects based on the given account.

Parameters:: accountReceivable - - the criteria that will be used to load the Account Presentment Preference objects(mandatory); associations - - a list of associations(optional)
Returns:: a list of inactive account Presentment Preferences of the given account
Throws:: java.lang.Exception

listPresentmentPreferences

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference> listPresentmentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                                                       throws java.lang.Exception

Lists Account Presentment Preference objects based on the given account.

Parameters:: accountReceivable - - the criteria that will be used to load the Account Presentment Preference objects(mandatory)
Returns:: a list of account Presentment Preferences of the given account
Throws:: java.lang.Exception

listPresentmentPreferences

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference> listPresentmentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                              java.util.ArrayList<java.lang.String> associations)
                                                                                                                       throws java.lang.Exception

Lists Account Presentment Preference objects based on the given account.

Parameters:: accountReceivable - - the criteria that will be used to load the Account Presentment Preference objects(mandatory); associations - - a list of associations(optional)
Returns:: a list of account Presentment Preferences of the given account
Throws:: java.lang.Exception

readUsageAllowanceLimitsByAccount

public abstract com.crm.dataobject.billing.CRMDOUsageAllowanceLimit readUsageAllowanceLimitsByAccount(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                               throws java.lang.Exception

Read Accounts Receivable Usage Allowance Limits

Parameters:: accountReceivable - - the account receivable(mandatory)
Returns:: the usage allowance limit
Throws:: java.lang.Exception

readUsageAllowanceLimits

public abstract com.crm.dataobject.billing.CRMDOUsageAllowanceLimit readUsageAllowanceLimits(java.lang.String uniqueIdentifier)
                                                                                      throws java.lang.Exception

Read Accounts Receivable Usage Allowance Limits

Parameters:: uniqueIdentifier - - the usage allowance limit unique identifier(mandatory)
Returns:: the usage allowance limit
Throws:: java.lang.Exception

readUsageAllowanceLimits

public abstract com.crm.dataobject.billing.CRMDOUsageAllowanceLimit readUsageAllowanceLimits(java.lang.String uniqueIdentifier,
                                                                                             java.util.ArrayList<java.lang.String> associations)
                                                                                      throws java.lang.Exception

Read Accounts Receivable Usage Allowance Limits

Parameters:: uniqueIdentifier - - the usage allowance limit unique identifier(mandatory); associations - - a list of associations(optional)
Returns:: the usage allowance limit
Throws:: java.lang.Exception

listUsageAllowanceLimitsPerService

public abstract java.util.ArrayList<com.crm.dataobject.billing.CRMDOUsageAllowanceLimitProduct> listUsageAllowanceLimitsPerService(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                                                            throws java.lang.Exception

List Accounts Receivable Usage Allowance Limits per Service

Parameters:: accountReceivable - - the account receivable(mandatory)
Returns:: the usage allowance limit products
Throws:: java.lang.Exception

listUsageAllowanceLimitsPerService

public abstract java.util.ArrayList<com.crm.dataobject.billing.CRMDOUsageAllowanceLimitProduct> listUsageAllowanceLimitsPerService(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                                   java.util.ArrayList<java.lang.String> associations)
                                                                                                                            throws java.lang.Exception

List Accounts Receivable Usage Allowance Limits per Service

Parameters:: accountReceivable - - the account receivable(mandatory); associations - - a list of associations(optional)
Returns:: the usage allowance limit products
Throws:: java.lang.Exception

newAccountPaymentPreference

public abstract com.crm.dataobject.accounts.CRMDOAccountPaymentPreference newAccountPaymentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                               throws java.lang.Exception

Instantiates and initializes a new account payment preference.

Parameters:: accountReceivable - - the account receivable to create a new account payment preference(mandatory)
Returns:: a new account payment preference
Throws:: java.lang.Exception

newAccountPresentmentPreference

public abstract com.crm.dataobject.accounts.CRMDOAccountPresentmentPreference newAccountPresentmentPreference(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                                       throws java.lang.Exception

Instantiates and initializes a new account presentment preference.

Parameters:: accountReceivable - - the account receivable to create a new account presentment preference(mandatory)
Returns:: a new account presentment preference
Throws:: java.lang.Exception

canBeAddedInAGroupAsMember
```
public java.lang.Boolean canBeAddedInAGroupAsMember(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                             throws java.lang.Exception
```
Determine if accounts receivable can be added in a group as a member

Parameters:

accountReceivable - - the account receivable to determine if it can be added in a group as a member(mandatory)

Returns:

true if the given account receivable can be added in a group as a parent, otherwise false

Throws:

java.lang.Exception

canBeAddedInAGroupAsParent
```
public java.lang.Boolean canBeAddedInAGroupAsParent(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                             throws java.lang.Exception
```
Determine if accounts receivable can be added in a group as a parent

Parameters:

accountReceivable - - the account receivable to determine if it can be added in a group as a parent(mandatory)

Returns:

true if the given account receivable can be added in a group as a parent, otherwise false

Throws:

java.lang.Exception

addMemberInAGroup

public com.crm.dataobject.accounts.CRMDOAccountReceivableMember addMemberInAGroup(com.crm.dataobject.accounts.CRMDOAccountReceivable parentAccountReceivable,
                                                                                  com.crm.dataobject.accounts.CRMDOAccountReceivable memberAccountReceivable,
                                                                                  com.crm.dataobject.accounts.AccountReceivableMemberFundingScope fundingScope,
                                                                                  java.util.ArrayList<com.crm.dataobject.products.CRMDOProduct> products,
                                                                                  java.util.ArrayList<com.crm.dataobject.products.CRMDOProductType> productTypes,
                                                                                  java.util.ArrayList<com.crm.dataobject.products.CRMDOProductFamily> productFamilies)
                                                                           throws java.lang.Exception

Add Member Accounts Receivable in an account group At least on of the following must be specified: products, productTypes, productFamilies

Parameters:: parentAccountReceivable - - the parent account receivable(mandatory); memberAccountReceivable - - the account receivable to add as member(mandatory); fundingScope - - the funding scope of the member(mandatory); products - - the products to add on the member(optional); productTypes - - the product types to add on the member(optional); productFamilies - - the product families to add on the member(optional)
Returns:: the new account receivable member
Throws:: java.lang.Exception

removeMemberFromAGroup

public com.crm.dataobject.accounts.CRMDOAccountReceivable removeMemberFromAGroup(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                          throws java.lang.Exception

Remove Member Accounts Receivable from an account group

Parameters:: accountReceivable - - the account receivable to remove from group(mandatory)
Returns:: the updated accounts receivable
Throws:: java.lang.Exception

newAccountReceivableMember

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivableMember newAccountReceivableMember(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                             throws java.lang.Exception

Instantiates and initializes a new account receivable member.

Parameters:: accountReceivable - - the account receivable to create a new account receivable member(mandatory)
Returns:: a new account receivable member
Throws:: java.lang.Exception

newAccountReceivableMemberProduct

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivableMemberProduct newAccountReceivableMemberProduct(com.crm.dataobject.accounts.CRMDOAccountReceivableMember accountReceivableMember)
                                                                                                           throws java.lang.Exception

Instantiates and initializes a new account receivable member product.

Parameters:: accountReceivableMember - - the account receivable member to create a new account receivable member product(mandatory)
Returns:: a new account receivable member product
Throws:: java.lang.Exception

newUsageAllowanceLimitProduct

public abstract com.crm.dataobject.billing.CRMDOUsageAllowanceLimitProduct newUsageAllowanceLimitProduct(com.crm.dataobject.billing.CRMDOUsageAllowanceLimit usageAllowanceLimit)
                                                                                                  throws java.lang.Exception

Instantiates and initializes a new usage allowance limit product.

Parameters:: usageAllowanceLimit - - the usage allowance limit to create a new usage allowance limit product(mandatory)
Returns:: a new usage allowance limit product
Throws:: java.lang.Exception

newAccountAllowedWalletTopUpProduct

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivableAllowedWalletTopUpProduct newAccountAllowedWalletTopUpProduct(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                                                         throws java.lang.Exception

Instantiates and initializes a new account allowed wallet top up product.

Parameters:: accountReceivable - - the account receivable to create a new account allowed wallet top up product(mandatory)
Returns:: a new account allowed wallet top up product
Throws:: java.lang.Exception

suspendAccount

public com.crm.dataobject.accounts.CRMDOAccountReceivable suspendAccount(com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                                                                  throws java.lang.Exception

Suspends an account. If the account has members, suspends members, and then suspends account

Parameters:: account - - the account to suspend
Returns:: the suspended account
Throws:: java.lang.Exception

activate

public com.crm.dataobject.accounts.CRMDOAccountReceivable activate(com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                                                            throws java.lang.Exception

Activates an account.

Parameters:: account - - the account to activate
Returns:: the updated account
Throws:: java.lang.Exception

terminateAccount
```
public com.crm.dataobject.accounts.CRMDOAccountReceivable terminateAccount(com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                                                                    throws java.lang.Exception
```
Terminates an account. Terminates the account members, if the account has members Validates the account termination Cancels the account wallet Deactivates the account tokens If account is related to a payment gateway account, deletes the payment gateway account and paymnet gateway cards

Parameters:

account - - the account to terminate

Returns:

the terminated account

Throws:

java.lang.Exception

changeParentAccountOfAGroup
```
public abstract void changeParentAccountOfAGroup(com.crm.dataobject.accounts.CRMDOAccountReceivable newParentAccountReceivable,
                                                 com.crm.dataobject.accounts.CRMDOAccountReceivable oldParentAccountReceivable)
                                          throws java.lang.Exception
```
Change Parent Accounts Receivable of an account group Loads all members of the old parent account and updates their parent

Parameters:

newParentAccountReceivable - - the account receivable to set as parent of a group(mandatory)

oldParentAccountReceivable - - the account receivable to remove from parent of a group(mandatory)

Throws:

java.lang.Exception

changeParentAccountOfAGroup

public abstract void changeParentAccountOfAGroup(com.crm.dataobject.accounts.CRMDOAccountReceivable newParentAccountReceivable,
                                                 com.crm.dataobject.accounts.CRMDOAccountReceivable oldParentAccountReceivable,
                                                 java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableMember> members)
                                          throws java.lang.Exception

Change Parent Accounts Receivable of an account group

Parameters:: newParentAccountReceivable - - the account receivable to set as parent of a group(mandatory); oldParentAccountReceivable - - the account receivable to remove from parent of a group(mandatory); members - - the members to move(mandatory)
Throws:: java.lang.Exception

updateMembershipInformation

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivableMember updateMembershipInformation(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                     com.crm.dataobject.accounts.AccountReceivableMemberFundingScope fundingScope,
                                                                                                     java.util.ArrayList<com.crm.dataobject.products.CRMDOProduct> products,
                                                                                                     java.util.ArrayList<com.crm.dataobject.products.CRMDOProductType> productTypes,
                                                                                                     java.util.ArrayList<com.crm.dataobject.products.CRMDOProductFamily> productFamilies,
                                                                                                     java.util.ArrayList<com.crm.dataobject.products.CRMDOProduct> removedProducts,
                                                                                                     java.util.ArrayList<com.crm.dataobject.products.CRMDOProductType> removedProductTypes,
                                                                                                     java.util.ArrayList<com.crm.dataobject.products.CRMDOProductFamily> removedProductFamilies)
                                                                                              throws java.lang.Exception

Update membership information of a member

Parameters:: accountReceivable - - the account receivable to add as member(mandatory); fundingScope - - the funding scope of the member(optional); products - - the products to add on the member(optional); productTypes - - the product types to add on the member(optional); productFamilies - - the product families to add on the member(optional); removedProducts - - the products to remove from member(optional); removedProductTypes - - the product types to remove from member(optional); removedProductFamilies - - the product families to remove from member(optional)
Returns:: the updated account receivable member
Throws:: java.lang.Exception

isAccountMemberAccessible
```
public abstract java.lang.Boolean isAccountMemberAccessible(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                            com.crm.dataobject.accounts.CRMDOAccountReceivableMember accountReceivableMember)
                                                     throws java.lang.Exception
```
Determine if an accounts receivable member is accessible.

Parameters:

accountReceivable - - the account receivable(mandatory)

accountReceivableMember - - the accounts receivable member to determine whether is accessible or not(mandatory)

Returns:

true if the given accounts receivable member is accessible, otherwise false

Throws:

java.lang.Exception

readAccountMember

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivableMember readAccountMember(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                    throws java.lang.Exception

Reads an account receivable member by the member account receivable.

Parameters:: accountReceivable - - the member account receivable(mandatory)
Returns:: the account receivable member
Throws:: java.lang.Exception

readAccountMember

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivableMember readAccountMember(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                           java.util.ArrayList<java.lang.String> associations,
                                                                                           java.util.ArrayList<java.lang.String> productAssociations)
                                                                                    throws java.lang.Exception

Reads an account receivable member by the member account receivable.

Parameters:: accountReceivable - - the member account receivable(mandatory); associations - - a list of associations(optional); associations - - a list of associations(optional)
Returns:: the account receivable member
Throws:: java.lang.Exception

listAccountGroupMembers

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableMember> listAccountGroupMembers(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                                               throws java.lang.Exception

List Account Group Members.

Parameters:: accountReceivable - - the criteria that will be used to load the Account Group Members objects(mandatory)
Returns:: a list of account group members of the given account
Throws:: java.lang.Exception

listAccountGroupMembers

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableMember> listAccountGroupMembers(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                      java.util.ArrayList<java.lang.String> associations)
                                                                                                               throws java.lang.Exception

List Account Group Members.

Parameters:: accountReceivable - - the criteria that will be used to load the Account Group Members objects(mandatory); associations - - a list of associations(optional)
Returns:: a list of account group members of the given account
Throws:: java.lang.Exception

listAccountGroupMemberFundedServices

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableMemberProduct> listAccountGroupMemberFundedServices(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                                                                   throws java.lang.Exception

List Accounts Receivable Funded Services.

Parameters:: accountReceivable - - the criteria that will be used to load the Account Group Member Funded Services objects(mandatory)
Returns:: a list of account group members of the given account
Throws:: java.lang.Exception

listAccountGroupMemberFundedServices

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableMemberProduct> listAccountGroupMemberFundedServices(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                                          java.util.ArrayList<java.lang.String> associations)
                                                                                                                                   throws java.lang.Exception

List Accounts Receivable Funded Services.

Parameters:: accountReceivable - - the criteria that will be used to load the Account Group Member Funded Services objects(mandatory); associations - - a list of associations(optional)
Returns:: a list of account group members of the given account
Throws:: java.lang.Exception

listAccessTokens

public abstract java.util.ArrayList<com.crm.dataobject.accesstokens.CRMDOAccessToken> listAccessTokens(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                                throws java.lang.Exception

List Access Tokens.

Parameters:: accountReceivable - - the criteria that will be used to load the Access Token objects(mandatory)
Returns:: a list of access tokens of the given account
Throws:: java.lang.Exception

listAccessTokens

public abstract java.util.ArrayList<com.crm.dataobject.accesstokens.CRMDOAccessToken> listAccessTokens(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                       java.util.ArrayList<java.lang.String> associations)
                                                                                                throws java.lang.Exception

List Access Tokens.

Parameters:: accountReceivable - - the criteria that will be used to load the Access Token objects(mandatory); associations - - a list of associations(optional)
Returns:: a list of access tokens of the given account
Throws:: java.lang.Exception

transferMoneyToWallet
```
public com.crm.dataobject.financialtransactions.CRMDOInvoice transferMoneyToWallet(com.crm.dataobject.wallets.CRMDOWalletDefinition walletDefinition,
                                                                                   com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                                                   java.math.BigDecimal amount)
                                                                            throws java.lang.Exception
```
Transfers money from an account to the account wallet Creates an invoice based on the On Transferring Money From Account To Wallet cause configured on active the wallet definition Creates a credit wallet transaction for the account wallet with the given amount and based on the On Transferring Money From Account To Wallet cause configured on active the wallet definition Posts the created invoice

Parameters:

walletDefinition - - the active wallet definition

account - - the account to transfer money from

amount - - the amount of money to transfer

Returns:

the created invoice

Throws:

java.lang.Exception

transferMoneyToWallet
```
public com.crm.dataobject.financialtransactions.CRMDOInvoice transferMoneyToWallet(com.crm.dataobject.wallets.CRMDOWalletDefinition walletDefinition,
                                                                                   com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                                                   java.math.BigDecimal amount,
                                                                                   com.crm.dataobject.wallets.CRMDOWallet wallet)
                                                                            throws java.lang.Exception
```
Transfers money from an account to the account wallet Creates a credit wallet transaction for the account wallet with the given amount and based on the On Transferring Money From Account To Wallet cause configured on active the wallet definition Creates an invoice based on WALLET RULES - CREDITING WALLETS - "Debit the Related Accounts Receivable due to transfer Money" configured on active the wallet definition

Parameters:

walletDefinition - - the active wallet definition

account - - the account to transfer money from

amount - - the amount of money to transfer

wallet - - the wallet to transfer money to

Returns:

the created invoice

Throws:

java.lang.Exception

setUsageAllowanceLimit

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivable setUsageAllowanceLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                   throws java.lang.Exception

Creates a usage allowance limit for an account receivable.

Parameters:: accountReceivable - - the accountReceivable to use
Returns:: the updated account receivable
Throws:: java.lang.Exception

getUsageAllowanceLimit

public abstract com.crm.dataobject.billing.CRMDOUsageAllowanceLimit getUsageAllowanceLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                    throws java.lang.Exception

Returns usage allowance limit for an account receivable.

Parameters:: accountReceivable - - the accountReceivable to use
Returns:: the usage allowance limit
Throws:: java.lang.Exception

resetUsageAllowanceLimit

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivable resetUsageAllowanceLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                     throws java.lang.Exception

Removes the usage allowance limits of the given account receivable.

Parameters:: accountReceivable - - the account receivable to remove the usage allowance limits for
Returns:: the updated account receivable
Throws:: java.lang.Exception

setUpRecurringPaymentSettings

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivable setUpRecurringPaymentSettings(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                          throws java.lang.Exception

Set up recurring payment settings

Parameters:: accountReceivable - - the account receivable to set up recurring payment settings
Returns:: the updated account receivable
Throws:: java.lang.Exception

createUsageAllowanceLimit

public abstract com.crm.dataobject.billing.CRMDOUsageAllowanceLimit createUsageAllowanceLimit(com.crm.dataobject.billing.CRMDOUsageAllowanceLimit usageAllowanceLimit)
                                                                                       throws java.lang.Exception

Create Usage Allowance Limit

Parameters:: usageAllowanceLimit - - the usage allowance limit to create(mandatory)
Returns:: the created Usage Allowance Limit
Throws:: java.lang.Exception; com.crm.exception.CannotCreateException

updateUsageAllowanceLimit

public abstract com.crm.dataobject.billing.CRMDOUsageAllowanceLimit updateUsageAllowanceLimit(com.crm.dataobject.billing.CRMDOUsageAllowanceLimit usageAllowanceLimit)
                                                                                       throws java.lang.Exception

Update Usage Allowance Limit

Parameters:: usageAllowanceLimit - - the usage allowance limit to create(mandatory)
Returns:: the updated Usage Allowance Limit
Throws:: java.lang.Exception; com.crm.exception.CannotUpdateEntityException

resetUsageAllowanceLimitBasedOnCurrency

public abstract com.crm.dataobject.accounts.CRMDOAccountReceivable resetUsageAllowanceLimitBasedOnCurrency(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                                    throws java.lang.Exception

Reset the usage allowance limit for an account receivable based on the currency.

Parameters:: accountReceivable - - the account to use
Returns:: the updated account receivable
Throws:: java.lang.Exception

newPaymentGatewayCard

public abstract com.crm.dataobject.paymentgateway.CRMDOPaymentGatewayCard newPaymentGatewayCard(com.crm.dataobject.accounts.CRMDOAccountPaymentPreference accountPaymentPreference)
                                                                                         throws java.lang.Exception

Instantiates and initializes a new payment gateway card.

Parameters:: accountPaymentPreference - - the account payment preference to create a new payment gateway card(mandatory)
Returns:: a new payment gateway card
Throws:: java.lang.Exception

listAllowedWalletTopUpProducts

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableAllowedWalletTopUpProduct> listAllowedWalletTopUpProducts(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                                                                         throws java.lang.Exception

List Allowed Wallet Top Up Products by account receivable.

Parameters:: accountReceivable - - the criteria that will be used to load the Allowed Wallet Top Up Products objects(mandatory)
Returns:: a list of allowed wallet top up products of the given account
Throws:: java.lang.Exception

listAllowedWalletTopUpProducts

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableAllowedWalletTopUpProduct> listAllowedWalletTopUpProducts(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                                                java.util.ArrayList<java.lang.String> associations)
                                                                                                                                         throws java.lang.Exception

List Allowed Wallet Top Up Products by account receivable.

Parameters:: accountReceivable - - the criteria that will be used to load the Allowed Wallet Top Up Products objects(mandatory); associations - - a list of associations(optional)
Returns:: a list of allowed wallet top up products of the given account
Throws:: java.lang.Exception

getValidWalletTopUpRule

public abstract com.crm.dataobject.accounts.AutomaticRecurringPaymentAutoTopUpRule getValidWalletTopUpRule(com.crm.dataobject.accounts.CRMDOAccountDefinition accountDefinition,
                                                                                                           com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                                    throws java.lang.Exception

Returns a valid auto top up rule

Parameters:: accountDefinition - - the account definition; accountReceivable - - the accounts receivable
Returns:: a wallet top up rule
Throws:: java.lang.Exception

listAccountGroupMemberFundedServices

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableMemberProduct> listAccountGroupMemberFundedServices(com.crm.dataobject.accounts.CRMDOAccountReceivableMember accountReceivableMember)
                                                                                                                                   throws java.lang.Exception

List Accounts Receivable Funded Services.

Parameters:: accountReceivableMember - - the criteria that will be used to load the Account Group Member Funded Services objects(mandatory)
Returns:: a list of account group members of the given account
Throws:: java.lang.Exception

listAccountGroupMemberFundedServices

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableMemberProduct> listAccountGroupMemberFundedServices(com.crm.dataobject.accounts.CRMDOAccountReceivableMember accountReceivableMember,
                                                                                                                                          java.util.ArrayList<java.lang.String> associations)
                                                                                                                                   throws java.lang.Exception

List Accounts Receivable Funded Services.

Parameters:: accountReceivableMember - - the criteria that will be used to load the Account Group Member Funded Services objects(mandatory); associations - - a list of associations(optional)
Returns:: a list of account group members of the given account
Throws:: java.lang.Exception

listPaymentGatewayCards

public abstract java.util.ArrayList<com.crm.dataobject.paymentgateway.CRMDOPaymentGatewayCard> listPaymentGatewayCards(com.crm.dataobject.accounts.CRMDOAccountPaymentPreference accountPaymentPreference)
                                                                                                                throws java.lang.Exception

List Payment Gateway Cards by Account Payment Preference.

Parameters:: accountPaymentPreference - - the criteria that will be used to load the Payment Gateway Card objects(mandatory)
Returns:: a list of Payment Gateway Cards of the given Account Payment Preference
Throws:: java.lang.Exception

listPaymentGatewayCards

public abstract java.util.ArrayList<com.crm.dataobject.paymentgateway.CRMDOPaymentGatewayCard> listPaymentGatewayCards(com.crm.dataobject.accounts.CRMDOAccountPaymentPreference accountPaymentPreference,
                                                                                                                       java.util.ArrayList<java.lang.String> associations)
                                                                                                                throws java.lang.Exception

List Payment Gateway Cards by Account Payment Preference.

Parameters:: accountPaymentPreference - - the criteria that will be used to load the Payment Gateway Card objects(mandatory); associations - - a list of associations(optional)
Returns:: a list of Payment Gateway Cards of the given Account Payment Preference
Throws:: java.lang.Exception

revertAmountToDefaultCurrency

public abstract java.math.BigDecimal revertAmountToDefaultCurrency(java.math.BigDecimal amount,
                                                                   com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                            throws java.lang.Exception

Revert amount to default currency

Parameters:: amount - - the amount to revert; accountReceivable - - the account receivable to check the currency
Returns:: the updated amount
Throws:: java.lang.Exception

updateCreditTerms

public com.crm.dataobject.accounts.CRMDOAccountReceivable updateCreditTerms(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                                            java.math.BigDecimal newCreditLimit,
                                                                            com.crm.dataobject.accounts.CreditRating newCreditRatingCode,
                                                                            com.crm.dataobject.accounts.CreditPeriodOperator newCreditPeriodOperator,
                                                                            java.lang.Integer newCreditPeriod)
                                                                     throws java.lang.Exception

Update the credit terms of an account.

Parameters:: account - - the account to change the credit limit for; newCreditLimit - - the credit limit to set; newCreditRatingCode - - the credit rating code to set; newCreditPeriodOperator - - the credit period operator to set; newCreditPeriod - - the new credit period in days to set
Returns:: the updated account
Throws:: java.lang.Exception

updateCreditTerms

public com.crm.dataobject.accounts.CRMDOAccountReceivable updateCreditTerms(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                                            java.math.BigDecimal newCreditLimit,
                                                                            com.crm.dataobject.accounts.CreditRating newCreditRatingCode,
                                                                            com.crm.dataobject.accounts.CreditPeriodOperator newCreditPeriodOperator,
                                                                            java.lang.Integer newCreditPeriod,
                                                                            com.crm.framework.util.UnitOfTime newCreditPeriodUOT)
                                                                     throws java.lang.Exception

Update the credit terms of an account.

Parameters:: account - - the account to change the credit limit for; newCreditLimit - - the credit limit to set; newCreditRatingCode - - the credit rating code to set; newCreditPeriodOperator - - the credit period operator to set; newCreditPeriod - - the new credit period in days to set
Returns:: the updated account
Throws:: java.lang.Exception

calculateRemainingUsageAllowanceWithoutLimit

public com.crm.dataobject.accounts.CRMDOAccountReceivable calculateRemainingUsageAllowanceWithoutLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                       java.util.Date validityDate,
                                                                                                       com.crm.dataobject.billing.CRMDOUsageAuthorisation usageAuthorisation)
                                                                                                throws java.lang.Exception

Calculate remaining usage allowance limit without limit.

Parameters:: accountReceivable - - the account receivable to calculate the allowed exceeded usage allowance; validityDate - - the date to calculate the allowed exceeded usage allowance; usageAuthorisation - - the usage authorisation to exclude
Returns:: the remaining usage allowance limit without limit
Throws:: java.lang.Exception

updateAccountPaymentPreferences
```
public void updateAccountPaymentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                     throws java.lang.Exception
```
Update the payment preferences of an account.

Parameters:

accountReceivable - - the account to update the payment preferences for

Throws:

java.lang.Exception

updateAccountPresentmentPreferences
```
public void updateAccountPresentmentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                         throws java.lang.Exception
```
Update the presentment preferences of an account.

Parameters:

accountReceivable - - the account to update the presentment preferences for

Throws:

java.lang.Exception

listAccountGroupMembers

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountReceivableMember> listAccountGroupMembers(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                      com.crm.dataobject.accounts.AccountReceivableMemberFundingScope fundingScope,
                                                                                                                      java.lang.Integer numberOfResults,
                                                                                                                      java.lang.Integer offSet)
                                                                                                               throws java.lang.Exception

List Account Group Members.

Parameters:: accountReceivable - - the criteria that will be used to load the Account Group Members objects(mandatory); fundingScope - - the founding scope(optional); numberOfResults - - the number or results(optional); offSet - - the offset(optional)
Returns:: a list of account group members of the given account
Throws:: java.lang.Exception

setAsPrimary

public com.crm.dataobject.accounts.CRMDOAccountReceivable setAsPrimary(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                throws java.lang.Exception

Sets a primary account.

Parameters:: accountReceivable - - the account to set as primary
Returns:: the updated account
Throws:: java.lang.Exception

identifyBillingLocation

public com.crm.dataobject.contactinfo.CRMDOContactInfoAddress identifyBillingLocation(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                               throws java.lang.Exception

Sets a primary account.

Parameters:: accountReceivable - - the account to set as primary
Returns:: the updated account
Throws:: java.lang.Exception

listPaymentPreferences

public abstract java.util.ArrayList<com.crm.dataobject.accounts.CRMDOAccountPaymentPreference> listPaymentPreferences(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                                                                                      com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting paymentGatewaySetting,
                                                                                                                      com.crm.dataobject.accounts.CRMDOAccountDefinition accountDefinition,
                                                                                                                      java.util.ArrayList<java.lang.String> associations)
                                                                                                               throws java.lang.Exception

Lists Account Payment Preference objects based on the given account.

Parameters:: accountReceivable - - the criteria that will be used to load the Account Payment Preference objects(mandatory); paymentGatewaySetting - - the criteria that will be used to load the Account Payment Preference objects(optional); accountDefinition - - the criteria that will be used to load the Account Payment Preference objects(optional); associations - - a list of associations(optional)
Returns:: a list of active account Payment Preferences of the given account
Throws:: java.lang.Exception

calculateCreditLimit
```
public java.math.BigDecimal calculateCreditLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                          throws java.lang.Exception
```
Return the credit limit on an account.

Parameters:

accountReceivable - - the account to return the credit limit for

Returns:

the credit limit for the account

Throws:

java.lang.Exception

calculateCreditLimit

public java.math.BigDecimal calculateCreditLimit(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                 com.crm.dataobject.accounts.CRMDOAccountDefinition accountDefinition)
                                          throws java.lang.Exception

Return the credit limit on an account.

Parameters:: accountReceivable - - the account to return the credit limit for; accountDefinition - - the account definition to get the definition credit limit
Returns:: the credit limit for the account
Throws:: java.lang.Exception

isUsedByGroupOrUnit
```
public java.lang.Boolean isUsedByGroupOrUnit(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                      throws java.lang.Exception
```
Determines if an Accounts Receivable is used by partner group or unit.

Parameters:

accountReceivable - - the Accounts Receivable to determine whether it is used or not by partner group or unit(mandatory)

Returns:

true if the given Accounts Receivable is used by partner group or unit, otherwise false

Throws:

java.lang.Exception

anonymizeContactAccounts
```
public void anonymizeContactAccounts(com.crm.dataobject.contactinfo.CRMDOContactInformation contact)
                              throws java.lang.Exception
```
Anonymizes the given contact information account

Parameters:

contact - - the contact information to anonymize its account

Throws:

java.lang.Exception

resetAccountingPeriodBalance

public void resetAccountingPeriodBalance(java.lang.String accountReceivableID,
                                         java.util.ArrayList<com.crm.dataobject.financialtransactions.CRMDOFinancialTransaction> transactions,
                                         java.util.ArrayList<com.crm.dataobject.CRMDO> allAccountingPeriods,
                                         java.util.Date asOfDate)
                                  throws java.lang.Exception

Resets the Accounting Period Balance for the Accounts Receivable given

Parameters:: accountReceivableID - - the Accounts Receivable to Reset the Accounting Period Balance for; transactions - - the FT of the Accounts Receivable to Reset the Accounting Period Balance for; allAccountingPeriods - -all of the Accounting Periods; asOfDate - - the date to help reset the balance
Throws:: java.lang.Exception

resetAccountingPeriod
```
public void resetAccountingPeriod(java.lang.String accountReceivableID,
                                  com.crm.dataobject.accounts.CRMDOAccountingPeriod accountingPeriod)
                           throws java.lang.Exception
```
Resets the Accounting Period for the Accounts Receivable given

Parameters:

accountReceivableID - - the Accounts Receivable to Reset the Accounting Period for

accountingPeriod - - the Accounting Period to set to the Accounts Receivable

Throws:

java.lang.Exception

closePeriod
```
public void closePeriod(java.lang.String accountReceivableID,
                        java.lang.String accountReceivableNumber,
                        java.math.BigDecimal openingBalance,
                        com.crm.dataobject.accounts.CRMDOAccountingPeriod openAccountingPeriod,
                        com.crm.dataobject.accounts.CRMDOAccountingPeriod newAccountingPeriod,
                        java.util.Date closedDate)
                 throws java.lang.Exception
```
Closes the Accounting Period for the Accounts Receivable

Parameters:

accountReceivableID - - the Accounts Receivable ID to close the Accounting Period for

accountReceivableNumber - - the Accounts Receivable Number to close the Accounting Period for

openingBalance - - the Accounts Receivable Opening balance to close the Accounting Period for

openAccountingPeriod- - the Open Accounting Period to close

newAccountingPeriod- - the New Open Accounting Period

closedDate-the - closed Date of the Accounting Period

Throws:

java.lang.Exception

setContactInformationAddresses

public com.crm.dataobject.contactinfo.CRMDOContactInformation setContactInformationAddresses(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable)
                                                                                      throws java.lang.Exception

Throws:: java.lang.Exception

Class CRMProcessNonSystemAccountReceivableBean

Constructor Summary

Method Summary

Methods inherited from class com.crm.process.CRMProcess

Methods inherited from class com.crm.businessobject.CRMBase

Methods inherited from class java.lang.Object

Constructor Detail

CRMProcessNonSystemAccountReceivableBean

Method Detail

newAccountReceivable

newAccountReceivable

update

applyCommonOperations

initialize

isAccessible

isCreditLimitExceeded

isBillingAddressAccessible

isActivePaymentPreferenceAccessible

isInactivePaymentPreferenceAccessible

isActivePresentmentPreferenceAccessible

isInactivePresentmentPreferenceAccessible

isFundedServiceAccessible

isUsageAllowanceLimitAccessible

isUsageAllowanceLimitsPerServiceAccessible

canBeActivated

canBeSuspended

canBeTerminated

canBeUpdated

canBeWrittenOff

applyOnEntity

read

read

readByName

readByName

readByNumber

readByNumber

readPrimary

readPrimary

read

writeOff

calculateOutstandingAmount

calculateOutstandingAmount

calculateBalance

calculateBalance

calculateCreditLimitStatus

updateCreditLimit

updateCreditPeriod

applyCreditPeriodRules

calculateConsumedUsageAllowance

calculateRemainingUsageAllowance

calculateAllowedExceededUsageAllowance

readBillingAddress

readBillingAddress

readActivePaymentPreference

readActivePaymentPreference

readActivePaymentPreferenceByType

readActivePaymentPreferenceByType

listActivePaymentPreferences

listActivePaymentPreferences

readInactivePaymentPreference

readInactivePaymentPreference

readInactivePaymentPreferenceByType

readInactivePaymentPreferenceByType

listInactivePaymentPreferences

listInactivePaymentPreferences

listPaymentPreferences

listPaymentPreferences

readActivePresentmentPreference

readActivePresentmentPreference

readActivePresentmentPreferenceByType

readActivePresentmentPreferenceByType

listActivePresentmentPreferences

listActivePresentmentPreferences

readInactivePresentmentPreference

readInactivePresentmentPreference

readInactivePresentmentPreferenceByType

readInactivePresentmentPreferenceByType

listInactivePresentmentPreferences

listInactivePresentmentPreferences

listPresentmentPreferences