Serialized Form

Package com.oracle.communications.brm.cc.batchpayments

Class com.oracle.communications.brm.cc.batchpayments.BatchPaymentsWork

class BatchPaymentsWork extends Object implements Serializable

Serialized Fields

externalUser

String externalUser

headerDataMap

Map headerDataMap

overrideThreshold

boolean overrideThreshold

paymentBatchFileHeader

PaymentBatchFileHeader paymentBatchFileHeader

paymentBatchStatistics

PaymentBatchStatistics paymentBatchStatistics

paymentsList

List paymentsList

queueStartDate

Calendar queueStartDate

retryProcess

boolean retryProcess

servletRequest

HttpServletRequest servletRequest

Package com.oracle.communications.brm.cc.brm_util

Class com.oracle.communications.brm.cc.brm_util.BEIDData

class BEIDData extends Object implements Serializable

Serialized Fields

m_Description

String m_Description

m_IsCurrencyResource

boolean m_IsCurrencyResource

m_JavaRoundingMode

Integer m_JavaRoundingMode

m_ResourceID

Integer m_ResourceID

m_Rounding

Integer m_Rounding

m_RoundingMode

Integer m_RoundingMode

m_Status

Integer m_Status

m_StatusDesc

String m_StatusDesc

m_StringCode

String m_StringCode

m_Symbol

String m_Symbol

m_ToleranceAmountMax

BigDecimal m_ToleranceAmountMax

m_ToleranceAmountMin

BigDecimal m_ToleranceAmountMin

m_TolerancePercent

BigDecimal m_TolerancePercent

Class com.oracle.communications.brm.cc.brm_util.CurrencyData

class CurrencyData extends BEIDData implements Serializable

Serialized Fields

m_IsEMUCurrency

boolean m_IsEMUCurrency

m_IsEuro

boolean m_IsEuro

m_IsSecondaryCurrencyRequired

boolean m_IsSecondaryCurrencyRequired

m_SecondaryCurrencies

Vector m_SecondaryCurrencies

Exception Class com.oracle.communications.brm.cc.brm_util.CurrencyRateException

class CurrencyRateException extends PortalException implements Serializable

Serialized Fields

m_DestCurID

int m_DestCurID

m_EBufExcptn

EBufException m_EBufExcptn

m_ReasonCode

int m_ReasonCode

m_SrcCurID

int m_SrcCurID

m_TransDate

Date m_TransDate

Class com.oracle.communications.brm.cc.brm_util.DDClassField

class DDClassField extends DDField implements Serializable

Serialized Fields

fIsAMandatoryField

boolean fIsAMandatoryField

fToBeDefinedBySystem

boolean fToBeDefinedBySystem

Package com.oracle.communications.brm.cc.exceptions

Exception Class com.oracle.communications.brm.cc.exceptions.ApplicationException

class ApplicationException extends RuntimeException implements Serializable

serialVersionUID:

1L

Exception Class com.oracle.communications.brm.cc.exceptions.InvalidClientException

class InvalidClientException extends RuntimeException implements Serializable

Exception Class com.oracle.communications.brm.cc.exceptions.InvalidTokenException

class InvalidTokenException extends Exception implements Serializable

Exception Class com.oracle.communications.brm.cc.exceptions.UnknownClientException

class UnknownClientException extends Exception implements Serializable

Package com.oracle.communications.brm.cc.model

Class com.oracle.communications.brm.cc.model.AbstractARActionType

class AbstractARActionType extends Extension implements Serializable

Class com.oracle.communications.brm.cc.model.Account

class Account extends Extension implements Serializable

Serialized Fields

accountFirstName

String accountFirstName

The account owner's first name.

accountLastName

String accountLastName

The account owner's last name.

accountNumber

String accountNumber

The account number.

balanceGroupRef

ResourceRef balanceGroupRef

billUnit

List<BillUnit> billUnit

A bill unit.

businessType

String businessType

The account's business type: 1 (consumer) or 2 (business).

contacts

List<Contacts> contacts

An account's contact information.

creationDate

Calendar creationDate

The date and time the account was created.

currency

int currency

The code for the account's primary currency.

currencySecondary

Integer currencySecondary

The account's secondary currency.

customerDurationDays

int customerDurationDays

The number of days that the account has been a customer.

customerDurationYears

Integer customerDurationYears

The number of years that the account has been a customer.

customerTypeCode

Integer customerTypeCode

The customer type: 1 (standard), 2 (brand), or 3 (subscription).

id

String id

The ID.

locale

String locale

The customer's locale, such as en_US or fr_FR. For a list of valid values, see "Locale Names" in BRM Developer's Guide.

organizationHierarchyTypeCode

Integer organizationHierarchyTypeCode

The internal code for the account's organization hierarchy type.

parentRef

ResourceRef parentRef

pendingDeferredActionsCount

Integer pendingDeferredActionsCount

The number of deferred actions in pending state.

securityCode1

String securityCode1

The first access code for voice verification.

securityCode2

String securityCode2

The second access code for voice verification.

statusCode

Integer statusCode

The code for the account's status: 0 (defunct), 10100 (active), 10102 (inactive), or 10103 (closed).

timezoneId

String timezoneId

The ID of the account's time zone.

wallet

Wallet wallet

Class com.oracle.communications.brm.cc.model.AccountAndBillItems

class AccountAndBillItems extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

billItem

List<BillItem> billItem

The bill item details.

firstName

String firstName

The first name of the customer owning the account.

id

String id

The ID.

lastName

String lastName

The last name of the customer owning the account.

Class com.oracle.communications.brm.cc.model.AccountCollectionDetails

class AccountCollectionDetails extends Extension implements Serializable

Serialized Fields

accountId

String accountId

The account's ID.

accountNumber

String accountNumber

The account's number.

address

String address

The account's address.

billUnitCollectionsDetails

List<AccountCollectionDetails.BillUnitCollectionsDetails> billUnitCollectionsDetails

The details for a bill unit in collections.

city

String city

The account's city.

company

String company

The account's company name.

country

String country

The account's country.

emailAddress

String emailAddress

The account's email address.

firstName

String firstName

The account owner's first name.

lastName

String lastName

The account owner's last name.

numberOfBillUnitsInCollections

int numberOfBillUnitsInCollections

The number of bill units that are in collections.

phonenumbers

List<AccountCollectionDetails.Phonenumbers> phonenumbers

The list of the account's phone numbers.

state

String state

The account's state or province.

zip

String zip

The account's ZIP or postal code.

Class com.oracle.communications.brm.cc.model.AccountCollectionDetails.BillUnitCollectionsDetails

class BillUnitCollectionsDetails extends Object implements Serializable

Serialized Fields

billUnitId

String billUnitId

The ID of the bill unit in collections.

billUnitName

String billUnitName

The name of the bill unit in collections.

collectionAgent

String collectionAgent

The collections agent assigned to the account.

collectionsActions

List<AccountCollectionDetails.BillUnitCollectionsDetails.CollectionsActions> collectionsActions

The list of collections actions for the account.

collectionsGroupId

String collectionsGroupId

The ID of the account's collections group.

currency

int currency

The code for the account's primary currency.

entryDate

Calendar entryDate

The date and time the account entered collections.

lastPaymentAmount

BigDecimal lastPaymentAmount

The amount of the account's last payment.

lastPaymentEffectiveDate

Calendar lastPaymentEffectiveDate

The effective date and time of the account's last payment.

lastPaymentId

String lastPaymentId

The ID of the account's last payment.

minimumPayment

BigDecimal minimumPayment

The minimum required payment.

notes

Notes notes

numberOfTimesInCollections

int numberOfTimesInCollections

The number of times the account has been in collections.

overdueAmount

BigDecimal overdueAmount

The amount that is overdue.

overdueDays

int overdueDays

The number of days the payment is overdue.

promiseToPayStatus

Integer promiseToPayStatus

The status of Promise to Pay in the collection scenario.

scenarioId

String scenarioId

The ID of the account's collections scenario.

scenarioName

String scenarioName

The name of the account's collections scenario.

Class com.oracle.communications.brm.cc.model.AccountCollectionDetails.BillUnitCollectionsDetails.CollectionsActions

class CollectionsActions extends Object implements Serializable

Serialized Fields

action

String action

The collections action's name.

actionId

String actionId

The collections action's ID.

amount

BigDecimal amount

The collections action amount.

completedDate

Calendar completedDate

The date and time the collections action was completed.

configCollectionsId

String configCollectionsId

The collections action's configuration ID.

dueDate

Calendar dueDate

The date and time the collections action is due.

status

Integer status

The collections action's status. Can be one of the following:

• 0: Pending
• 1: Canceled
• 2: Completed
• 3: Error
• 4: Did not run.
• 5: Waiting for a dependent

Class com.oracle.communications.brm.cc.model.AccountCollectionDetails.Phonenumbers

class Phonenumbers extends Object implements Serializable

Serialized Fields

number

String number

The phone number.

phonetype

Integer phonetype

The phone number's type.

Class com.oracle.communications.brm.cc.model.AccountContactDetails

class AccountContactDetails extends Extension implements Serializable

Serialized Fields

accountId

String accountId

The ID of the account.

accountNumber

String accountNumber

The account number.

address

String address

The address for the account.

city

String city

The city for the account.

company

String company

The company name.

country

String country

The country.

firstName

String firstName

The customer's first name.

lastName

String lastName

The customer's last name.

middleName

String middleName

The customer's middle name.

state

String state

The state.

zip

String zip

The zip code.

Class com.oracle.communications.brm.cc.model.AccountDetails

class AccountDetails extends Object implements Serializable

Serialized Fields

accountNumber

String accountNumber

The account number.

contacts

List<Contacts> contacts

An account's contact information.

currency

int currency

The primary currency.

Class com.oracle.communications.brm.cc.model.AccountGroup

class AccountGroup extends Extension implements Serializable

Serialized Fields

bundles

List<PurchasedBundle> bundles

lastStatusChange

Calendar lastStatusChange

The date and time the account group's status was last modified.

status

Integer status

The account group's status.

Class com.oracle.communications.brm.cc.model.AccountHierarchy

class AccountHierarchy extends Extension implements Serializable

Serialized Fields

arBillUnitRef

ResourceRef arBillUnitRef

billUnitId

String billUnitId

The ID of the bill unit in the hierarchy.

notes

Notes notes

parentAccountId

String parentAccountId

The ID of the parent account in the hierarchy.

paymentInstrumentRef

ResourceRef paymentInstrumentRef

Class com.oracle.communications.brm.cc.model.AccountSummary

class AccountSummary extends Extension implements Serializable

Serialized Fields

billInProgressDue

BigDecimal billInProgressDue

The in progress amount due for the bill unit.

disputed

BigDecimal disputed

The amount for the bill unit that is in dispute.

dueNow

BigDecimal dueNow

The amount that is due now.

id

ResourceRef id

The ID for the bill unit.

numBills

BigInteger numBills

The number of bills associated with the bill unit.

paymentTypeId

String paymentTypeId

The ID for the bill unit's payment type.

pendingDue

BigDecimal pendingDue

The amount for the bill unit that is in pending state.

pendingDueDate

Calendar pendingDueDate

The date and time the pending amount is due.

unallocatedAdjustments

BigDecimal unallocatedAdjustments

The adjustment amount that is still unallocated.

unallocatedPayments

BigDecimal unallocatedPayments

The payment amount that is still unallocated.

Class com.oracle.communications.brm.cc.model.AdjustmentAccount

class AdjustmentAccount extends ARActionRequestType implements Serializable

Serialized Fields

validityPeriod

AdjustmentAccount.ValidityPeriod validityPeriod

A validity period.

Class com.oracle.communications.brm.cc.model.AdjustmentAccount.ValidityPeriod

class ValidityPeriod extends Object implements Serializable

Serialized Fields

validFrom

Calendar validFrom

The date and time the validity period starts.

validTo

Calendar validTo

The date and time the validity period ends.

Class com.oracle.communications.brm.cc.model.AdjustmentBill

class AdjustmentBill extends AdjustmentBillType implements Serializable

Class com.oracle.communications.brm.cc.model.AdjustmentBillType

class AdjustmentBillType extends ARActionRequestType implements Serializable

Serialized Fields

billItem

List<BillItem> billItem

The bill item details.

Class com.oracle.communications.brm.cc.model.AdjustmentDetails

class AdjustmentDetails extends Extension implements Serializable

Serialized Fields

accountId

String accountId

The ID of the account associated with the adjustment.

adjustmentId

String adjustmentId

The adjustment's ID.

allocatedAmount

BigDecimal allocatedAmount

The amount of the adjustment that has been allocated.

billDetails

List<AdjustmentDetails.BillDetails> billDetails

effectiveDate

Calendar effectiveDate

The date and time the adjustment takes effect.

notes

Notes notes

originalAdjustmentAmount

BigDecimal originalAdjustmentAmount

The original amount before the adjustment.

taxAmount

BigDecimal taxAmount

The amount of tax associated with the adjustment.

unallocatedAmount

BigDecimal unallocatedAmount

The amount of the adjustment that has not been allocated.

Class com.oracle.communications.brm.cc.model.AdjustmentDetails.BillDetails

class BillDetails extends Object implements Serializable

Serialized Fields

billId

String billId

The ID of the bill.

cycleEnds

Calendar cycleEnds

The date and time the billing cycle ends.

cycleStarts

Calendar cycleStarts

The date and time the billing cycle starts.

dueAmount

BigDecimal dueAmount

The total amount due.

dueDate

Calendar dueDate

The date and time the bill is due.

eventsAffectedCount

long eventsAffectedCount

The number of events affected by the bill.

itemsAffected

List<AdjustmentDetails.BillDetails.ItemsAffected> itemsAffected

The list of bill items in the bill.

itemsAffectedCount

long itemsAffectedCount

The number of bill items affected by the bill.

Class com.oracle.communications.brm.cc.model.AdjustmentDetails.BillDetails.ItemsAffected

class ItemsAffected extends Object implements Serializable

Serialized Fields

accountNumber

String accountNumber

The account number associated with the bill item.

amount

BigDecimal amount

The bill item amount.

billNumber

String billNumber

The bill number associated with the bill item.

billUnitName

String billUnitName

The name of the bill unit associated with the bill item.

cycleEnds

Calendar cycleEnds

The date and time the billing cycle ends.

cycleStarts

Calendar cycleStarts

The date and time the billing cycle starts.

item

String item

The bill item.

settledNonTaxedAmount

BigDecimal settledNonTaxedAmount

The nontaxable amount for the bill item settled by the adjustment.

settledTaxAmount

BigDecimal settledTaxAmount

The amount of tax for the bill item settled by the adjustment.

settledTaxedAmount

BigDecimal settledTaxedAmount

The taxable amount for the bill item settled by the adjustment.

Class com.oracle.communications.brm.cc.model.AdjustmentEvent

class AdjustmentEvent extends EventARAction implements Serializable

Class com.oracle.communications.brm.cc.model.AdjustmentItem

class AdjustmentItem extends ARActionRequestType implements Serializable

Class com.oracle.communications.brm.cc.model.AdjustmentNonCurrencyBalance

class AdjustmentNonCurrencyBalance extends AractionBaseType implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

amount

BigDecimal amount

The amount of the adjustment.

balanceGroupRef

ResourceRef balanceGroupRef

elementId

Integer elementId

The element ID of the noncurrency balance bucket to be adjusted. This field is optional. If not provided, the system will choose the bucket.

resourceId

Integer resourceId

The resource ID of the noncurrency balance to adjust.

validFrom

Calendar validFrom

The date and time the adjustment's validity period starts.

validTo

Calendar validTo

The date and time the adjustment's validity period ends.

Class com.oracle.communications.brm.cc.model.ApplyLoan

class ApplyLoan extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

amount

BigDecimal amount

The loan amount.

channel

String channel

The channel requesting the loan. For example, USSD or IVR.

locale

String locale

The locale associated with the loan.

resourceId

BigDecimal resourceId

The ID of the resource associated with the loan.

service

ApplyLoan.Service service

A reference to the service associated with the loan.

type

Integer type

The type of loan. Can be one of the following:

• 0: Currency or emergency loan
• 1: Data loan
• 2: Hybrid loan

zoneMapName

String zoneMapName

The name of the zone map associated with the loan.

zoneMapTarget

String zoneMapTarget

The zone map associated with the loan.

Class com.oracle.communications.brm.cc.model.ApplyLoan.Service

class Service extends Object implements Serializable

Serialized Fields

id

String id

The ID of the service associated with the loan.

type

String type

The type of the service associated with the loan.

Class com.oracle.communications.brm.cc.model.ApplyLoanResponse

class ApplyLoanResponse extends Extension implements Serializable

Serialized Fields

amount

BigDecimal amount

availableLoanBalance

BigDecimal availableLoanBalance

availableLoanLimit

BigDecimal availableLoanLimit

balances

List<Balance> balances

creditLimit

BigDecimal creditLimit

currentBalance

BigDecimal currentBalance

loanFee

BigDecimal loanFee

loanFeeObj

ResourceRef loanFeeObj

loanObj

ResourceRef loanObj

tax

BigDecimal tax

Class com.oracle.communications.brm.cc.model.AractionBaseType

class AractionBaseType extends AbstractARActionType implements Serializable

Serialized Fields

actionAffectsRef

ResourceRef actionAffectsRef

effective

Calendar effective

The date and time the adjustment takes effect.

notes

Notes notes

Class com.oracle.communications.brm.cc.model.ARActionRequest

class ARActionRequest extends Extension implements Serializable

Serialized Fields

arAction

AbstractARActionType arAction

Class com.oracle.communications.brm.cc.model.ARActionRequestType

class ARActionRequestType extends AractionBaseType implements Serializable

Serialized Fields

amount

BigDecimal amount

The amount of the adjustment.

amountIsCredit

Boolean amountIsCredit

Whether the adjustment is a credit (true) or a debit (false).

includeTax

Boolean includeTax

Whether to include the tax in the adjustment (true) or not (false).

percent

BigDecimal percent

The amount of the adjustment, as a percentage. For example, enter 5 for 5%.

resourceId

Integer resourceId

The ID of the resource to adjust.

Class com.oracle.communications.brm.cc.model.ArActionsList

class ArActionsList extends Extension implements Serializable

Serialized Fields

accountNumber

String accountNumber

The account number.

arActionAmount

BigDecimal arActionAmount

The amount associated with the A/R action.

arActionId

String arActionId

The ID of the A/R action.

arActionRef

ResourceRef arActionRef

arActionType

Integer arActionType

The type of A/R action: item adjustment (0), event adjustment (1), bill adjustment (2), account adjustment (3), refund (4), open item dispute (6), settled item dispute (7), item payment (8), open event dispute (9), settled event dispute (10), open bill dispute (11), settled bill dispute (12), account writeoff (13), bill writeoff (14), or item writeoff (15).

arUnallocatedAmount

BigDecimal arUnallocatedAmount

The amount that is still unallocated.

billID

String billID

The ID of the bill.

billingStatus

Integer billingStatus

The billing status: billed (1) or unbilled (2).

billUnitName

String billUnitName

The name of the bill unit.

createdDate

Calendar createdDate

The date and time the A/R action was created.

effectiveDate

Calendar effectiveDate

The date and time the A/R action takes effect.

firstName

String firstName

The customer's first name.

impactedEvents

List<EventImpactType> impactedEvents

The list of impacted events.

itemName

String itemName

The item name.

lastName

String lastName

The customer's last name.

Class com.oracle.communications.brm.cc.model.AssignCollectionsAgent

class AssignCollectionsAgent extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

billunitRef

ResourceRef billunitRef

collectionAgent

String collectionAgent

The collections agent.

scenarioRef

ResourceRef scenarioRef

Class com.oracle.communications.brm.cc.model.AssignSuspensePaymentHandler

class AssignSuspensePaymentHandler extends Extension implements Serializable

Serialized Fields

locale

String locale

The locale of the suspense payment handler, such as en_US or fr_FR. For a list of valid values, see "Locale Names" in BRM Developer's Guide.

paymentEventRef

ResourceRef paymentEventRef

userId

int userId

The user ID of the suspense payment handler.

userName

String userName

The user name of the suspense payment handler.

Class com.oracle.communications.brm.cc.model.Balance

class Balance extends Object implements Serializable

Serialized Fields

amount

BigDecimal amount

type

Integer type

Class com.oracle.communications.brm.cc.model.BalanceGroup

class BalanceGroup extends Extension implements Serializable

Serialized Fields

balances

List<BalanceGroup.Balances> balances

The list of balances associated with the balance group.

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

id

String id

The ID.

monitorType

String monitorType

The monitoring group type. Allowed Values:

• H_CE (Hierarchy Credit Exposure)
• PR_CE (Payment Responsible Credit Exposure)
• SUB_CE (Subscription Credit Exposure)
• PR_RTCE (Payment Responsible Real-Time Credit Enforcement)

name

String name

The name of the balance group.

services

List<ServiceType> services

Class com.oracle.communications.brm.cc.model.BalanceGroup.Balances

class Balances extends Object implements Serializable

Serialized Fields

creditFloor

BigDecimal creditFloor

The credit floor associated with the balance.

creditLimit

BigDecimal creditLimit

The credit limit associated with the balance.

creditThresholds

Integer creditThresholds

The credit thresholds associated with the balance.

creditThresholdsFixed

String creditThresholdsFixed

The value at which to send a notification, such as 30 US dollars or 30 minutes.

currentBalance

BigDecimal currentBalance

The current balance.

dynamicCreditFloor

Boolean dynamicCreditFloor

Whether to use a dynamic credit floor (true) or not (false). The default is false.

expiredBeforeUsing

BigDecimal expiredBeforeUsing

The number of days until the balance expires.

formattedCreditThresholds

String formattedCreditThresholds

The balance percentage usage at which to notify the customer.

loanThresholds

Integer loanThresholds

The percent-based threshold for offering a loan. If the customer's balance falls below this percent, they are notified and offered a loan.

loanThresholdsFixed

String loanThresholdsFixed

The fixed amount threshold for offering a loan. If the customer's balance falls below this amount, they are notified and offered a loan.

modifyLimit

Boolean modifyLimit

Whether a credit limit is being modified by the request (true) or not (false).

outstandingAmount

BigDecimal outstandingAmount

An amount that the customer still owes, for loans or when they exceed their credit limit.

overrideCreditLimit

Integer overrideCreditLimit

Whether to override the credit limit. Allowed Values: 0 (Enforce Credit Limit) or 1 (Override credit limit).

resourceId

Integer resourceId

The resource ID associated with the balance.

subBalances

List<SubBalances> subBalances

tempCreditLimit

List<TempCreditLimit> tempCreditLimit

Class com.oracle.communications.brm.cc.model.BalanceImpact

class BalanceImpact extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

Link to the account object whose balance is impacted as specified by amount.

amount

Double amount

The impact to the account balance. The value may be either positive or negative.

balanceGroupRef

ResourceRef balanceGroupRef

Link to the balance_group object whose balance is impacted as specified by AMOUNT field in this array element. If this balance is sponsored, then this field points to the sponsorer's balance_group.

deferredAmount

Double deferredAmount

Tax-deferred amount.

discount

Double discount

The discount applied to this balance impact.

discountInfo

String discountInfo

Discount related information from IntegRate.Loaded via IREL.

glId

Integer glId

GLID associated with this balance impact. Don't care if 0.

impactCategory

String impactCategory

Name of the impact category that was used to generate this balance impact for the rated event.

impactType

Integer impactType

Balance impact type - rated by Infranet rated-engine.

itemObj

ResourceRef itemObj

Link to the item object affected due to this event.

lineage

String lineage

Lineages of event fields if zonemap is used in rate plan selection.

offeringRef

ResourceRef offeringRef

purchased_product or purchased_discount poid.

originalAmount

Double originalAmount

This field reflect the secondary currency amount specified in a pre-rated incoming event.

originalResourceId

Integer originalResourceId

Numeric value of the currency used to specify the amount in original amount field.

outstandingAmount

Double outstandingAmount

This field represents the outstanding amount.

percent

Double percent

Proration percentage for cycle events.

productObj

ResourceRef productObj

Link to the product object used to generate this balance impact for rated event.

quantity

Double quantity

Quantity applied - Number of units that were actually applied using this rate.

rateObj

ResourceRef rateObj

Link to the rate object that was used to generate this balance impact for rated events.

rateTag

String rateTag

Description of the rate used.

resourceId

int resourceId

Numeric value of the resource that is impacted.

rumName

String rumName

The rum name.

taxCode

String taxCode

Tax code for the rate that was used. When taxes do not apply this field will be set to 0.

taxExemptionCode

String taxExemptionCode

The tax exemption code.

Class com.oracle.communications.brm.cc.model.BasePaymentType

class BasePaymentType extends PaymentInstrumentType implements Serializable

Class com.oracle.communications.brm.cc.model.BatchInfoType

class BatchInfoType extends Extension implements Serializable

Serialized Fields

batchCurrency

int batchCurrency

The currency of the batch

batchDate

long batchDate

The date of the batch

batchId

String batchId

The ID of the batch

batchTotalRecords

int batchTotalRecords

The total number of records in the batch

batchTypeCode

String batchTypeCode

The payment method type. Allowed Values:

• 10003 (Credit card)
• 10005 (Direct debit)
• 10011 (Cash)
• 10012 (Check)
• 10013 (Wire Transfer)
• 10014 (Inter-bank payment order)
• 10015 (Postal order)

batchTypeName

String batchTypeName

The name of the batch type. Allowed values: Payment, Refund, or Reversal.

lockBoxDate

Long lockBoxDate

The date of the lockbox

lockBoxId

String lockBoxId

The lockbox ID

Class com.oracle.communications.brm.cc.model.BatchPaymentTemplates

class BatchPaymentTemplates extends Extension implements Serializable

Serialized Fields

locale

String locale

The template's locale, such as en_US or fr_FR. For a list of valid values, see \"Locale Names\" in BRM Developer's Guide.

payTypeCode

int payTypeCode

The payment method type. Allowed Values:

• 10011 (Cash payment batch)
• 10012 (Check payment batch)
• 10013 (Wire-transfer payment batch)
• 10014 (Inter-bank payment order payment batch)
• 10015 (Postal order payment batch)
• 10017 (Failed payment batch)

payTypeName

String payTypeName

The payment type name, such as Cash Payment Batch or Failed Payment Batch.

templateName

String templateName

The file name for the batch payment template.

Class com.oracle.communications.brm.cc.model.BatchRecordsList

class BatchRecordsList extends Extension implements Serializable

Serialized Fields

batchInformation

BatchInfoType batchInformation

batchRecords

List<BatchRecordsType> batchRecords

Class com.oracle.communications.brm.cc.model.BatchRecordsType

class BatchRecordsType extends Extension implements Serializable

Serialized Fields

accountCurrency

Integer accountCurrency

The account currency of the customer's account.

accountNumber

String accountNumber

The customer's account number.

accountRef

ResourceRef accountRef

accountType

Integer accountType

The accounting type associated with the account returned by the SelectItems opcode.

allocationDeferred

Integer allocationDeferred

Whether to allocate payments to items (0) or keep them unallocated at the account level (1). This only applies to payments, so for refund and reversal batches, this value should be null.

amount

BigDecimal amount

Amount to be paid, refunded, or reversed.

billinfo

List<BillinfoType> billinfo

billItem

List<BillItemType> billItem

billNumber

String billNumber

The customer's bill number to which the record should be applied.

channelId

Integer channelId

The description of the channel

chargebackDate

Long chargebackDate

The date and time the bill item was created.

comment

String comment

Notes associated with the record

dueAmount

BigDecimal dueAmount

The amount due

firstName

String firstName

Person's first name

lastName

String lastName

Person's last name

originalTransactionDate

Long originalTransactionDate

The original transaction date for reversal batch records

payInfo

Object payInfo

The payment information.

paymentId

String paymentId

The ID of the record.

reasonDomainId

Integer reasonDomainId

The reason Domain ID returned by the validation opcode

reasonId

Integer reasonId

The reason ID returned in by the validation opcode

selectResult

Integer selectResult

The result returned by the SelectItems opcode for validation

selectStatus

Integer selectStatus

The select status returned by the SelectItems opcode

status

int status

The status of the record. Allowed values:

• 0 (Input)
• 1 (Validated)
• 2 (Validated (with MBI distribution))
• 3 (Validated (written-off))
• 4 (Suspended)
• 5 (Manually Suspended)
• 6 (Allocate)
• 7 (Error)
• 8 (Submit)
• 9 (Batch Submit Error)
• 10 (Empty)

statusCode

BigInteger statusCode

The status code for the record

statusDescription

int statusDescription

The status description of the record. Allowed values:

• 0 (Empty)
• 1 (Error finding account or bill)
• 2 (Error selecting items for payment)
• 3 (Payment allocation required)
• 4 (Payment allocation required due to overpayment)
• 5 (Payment allocation required due to underpayment)
• 6 (Payment allocation suggested)
• 7 (Payment allocation suggested due to overpayment)
• 8 (Payment allocation suggested due to underpayment)
• 9 (Multiple payments to the same account are not allowed in the same batch. Remove or modify this row)
• 10 (Bill number and account number mismatch)
• 11 (Currency Conversion Rates)
• 12 (Duplicate Account)
• 13 (Invalid Payment ID)
• 14 (Duplicate Payment ID)
• 15 (Payment has already been reversed)
• 16 (Payment not able to reverse)
• 17 (Error in distribution to Multiple Bill Infos)

Class com.oracle.communications.brm.cc.model.Bill

class Bill extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

adjusted

BigDecimal adjusted

The amount on the bill that was adjusted.

amount

BigDecimal amount

The amount to be allocated.

arActionsAmtExcludingPayments

BigDecimal arActionsAmtExcludingPayments

The total of all accounts receivable actions applied toward the bill, excluding any payments.

arBillinfoRef

ResourceRef arBillinfoRef

billDisputed

Boolean billDisputed

Whether the bill includes a disputed item (true) or not (false).

billInfoId

String billInfoId

The ID of the bill unit associated with the bill.

billNo

String billNo

The bill number.

billPaidDate

Calendar billPaidDate

The date and time the bill was paid.

billUnitRef

ResourceRef billUnitRef

creationDate

Calendar creationDate

The date and time the bill was created.

currency

Integer currency

The type of currency associated with the bill.

currentTotal

BigDecimal currentTotal

The current total of the bill.

cycleEnds

Calendar cycleEnds

The date and time the billing cycle ends.

cycleStarts

Calendar cycleStarts

The date and time the billing cycle starts.

disputed

BigDecimal disputed

The amount in the bill that is in dispute.

due

BigDecimal due

The amount due for the bill.

dueDate

Calendar dueDate

The date and time the bill is due.

hierarchySize

Integer hierarchySize

The number of bills in a hierarchy.

id

String id

The ID.

name

String name

he name of the bill.

originalBillNo

String originalBillNo

The bill number associated with the original bill.

parent

ResourceRef parent

parentAccountNumber

String parentAccountNumber

The account number of the parent associated with the bill.

parentAccountRef

ResourceRef parentAccountRef

parentCompanyName

String parentCompanyName

The company name of the parent associated with the bill.

parentFirstName

String parentFirstName

The first name of the parent associated with the bill.

parentLastName

String parentLastName

The last name of the parent associated with the bill.

parentSalutation

String parentSalutation

The title of the parent associated with the bill.

previousTotal

BigDecimal previousTotal

The previous total for the bill.

receivedForBill

BigDecimal receivedForBill

The payment amount received for the bill.

recurringCharges

BigDecimal recurringCharges

The total amount of all recurring charges in the bill.

subordsTotal

BigDecimal subordsTotal

The total amount from all subordinates, if the bill is a parent in a billing hierarchy.

totalDue

BigDecimal totalDue

The total due for the bill.

transfered

BigDecimal transfered

The amount in the bill that has been transferred.

writeoff

BigDecimal writeoff

The amount in the bill that has been written off.

Class com.oracle.communications.brm.cc.model.BillChargeGroup

class BillChargeGroup extends Extension implements Serializable

Serialized Fields

account

AccountAndBillItems account

services

List<ServicesAndBillItems> services

Class com.oracle.communications.brm.cc.model.BillDetails

class BillDetails extends Extension implements Serializable

Serialized Fields

fromOtherAccounts

BillChargeGroup fromOtherAccounts

fromPayingAccount

BillChargeGroup fromPayingAccount

Class com.oracle.communications.brm.cc.model.BillinfoType

class BillinfoType extends Extension implements Serializable

Serialized Fields

accountingType

Integer accountingType

The bill unit's accounting type. Allowed values: 1 (Open item) or 2 (Balance forward).

amount

BigDecimal amount

The amount allocated.

billinfoRef

ResourceRef billinfoRef

bills

List<BillItemType> bills

items

List<BillItemType> items

Class com.oracle.communications.brm.cc.model.BillingHierarchy

class BillingHierarchy extends Extension implements Serializable

Serialized Fields

account

List<Account> account

An account.

numberOfChildren

int numberOfChildren

Class com.oracle.communications.brm.cc.model.BillItem

class BillItem extends Extension implements Serializable

Serialized Fields

accountName

String accountName

The name of the account.

accountNumber

String accountNumber

The account number associated with the bill item.

accountRef

ResourceRef accountRef

adjusted

BigDecimal adjusted

The total amount from debit and credit adjustments made to the bill item.

aliasList

List<BillItem.AliasList> aliasList

The list of aliases in the bill item.

amount

BigDecimal amount

The amount of the bill item.

arBillinfoRef

ResourceRef arBillinfoRef

arBillRef

ResourceRef arBillRef

billInfoId

String billInfoId

The ID of the /billinfo object.

billinfoRef

ResourceRef billinfoRef

billNo

String billNo

The bill number.

billRef

ResourceRef billRef

closedDate

Calendar closedDate

The date and time the bill item was closed. If the bill item is reopened for an adjustment, this is reset until the bill item is closed again.

creationDate

Calendar creationDate

The date and time the bill item was created.

currency

Integer currency

The currency for the bill item, copied from the currency of the associated account.

deltaDue

BigDecimal deltaDue

The delta amount due.

discount

BigDecimal discount

The amount discounted for the bill item.

disputed

BigDecimal disputed

The total amount from disputes associated with the bill item.

due

BigDecimal due

The amount due for the bill item.

dueDate

Calendar dueDate

The date when the amount in the bill item is due.

firstName

String firstName

The first name of the account holder.

id

String id

The ID.

itemNo

String itemNo

The bill item's number.

lastName

String lastName

The last name of the account holder.

login

String login

The username associated with the bill item.

name

String name

The bill item's name.

received

BigDecimal received

The amount of payments or credits applied to the bill item.

serviceRef

ResourceRef serviceRef

serviceTypeName

String serviceTypeName

The name of the service type.

status

String status

The status of the bill item: active (10100), inactive (10102), or closed (10103)

transfered

BigDecimal transfered

The amount transferred out of the bill item.

transferInto

List<BillItem.TransferInto> transferInto

transferOut

List<BillItem.TransferOut> transferOut

type

String type

The bill item's type.

writeoff

BigDecimal writeoff

The amount written off for the bill item.

Class com.oracle.communications.brm.cc.model.BillItem.AliasList

class AliasList extends Object implements Serializable

Serialized Fields

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

name

String name

The name of the alias.

Class com.oracle.communications.brm.cc.model.BillItem.TransferInto

class TransferInto extends Object implements Serializable

Serialized Fields

creationDate

Calendar creationDate

The creation date for the bill item from which the balance was transferred.

due

BigDecimal due

The due date for the bill item from which the balance was transferred.

itemNo

String itemNo

The bill item number for the bill item from which the balance was transferred.

itemRef

ResourceRef itemRef

name

String name

The name of the bill item from which the balance was transferred.

transfered

BigDecimal transfered

The amount transferred from the source bill item.

Class com.oracle.communications.brm.cc.model.BillItem.TransferOut

class TransferOut extends Object implements Serializable

Serialized Fields

creationDate

Calendar creationDate

The creation date for the bill item to which the balance was transferred.

due

BigDecimal due

The due date for the bill item to which the balance was transferred.

itemNo

String itemNo

The bill item number for the bill item to which the balance was transferred.

itemRef

ResourceRef itemRef

name

String name

The name of the bill item to which the balance was transferred.

transfered

BigDecimal transfered

The amount transferred to the target bill item.

Class com.oracle.communications.brm.cc.model.BillItemType

class BillItemType extends Extension implements Serializable

Serialized Fields

amount

BigDecimal amount

The amount of the bill item.

billinfoRef

ResourceRef billinfoRef

billRef

ResourceRef billRef

due

BigDecimal due

The amount due for the bill item.

id

String id

The ID of the bill or bill item.

Class com.oracle.communications.brm.cc.model.BillUnit

class BillUnit extends Extension implements Serializable

Serialized Fields

accountingCycleDom

Integer accountingCycleDom

The bill unit's accounting cycle day of month (DOM).

accountingCycleEnd

Calendar accountingCycleEnd

The date and time the accounting cycle ends.

accountingCycleStart

Calendar accountingCycleStart

The date and time the accounting cycle starts.

accountingCyclesUntilBillCycleEnds

Integer accountingCyclesUntilBillCycleEnds

The number of monthly accounting cycles remaining until the current billing cycle ends.

accountingType

Integer accountingType

The bill unit's accounting type: open item (1) or balance forward (2).

accountRef

ResourceRef accountRef

arBillUnitRef

ResourceRef arBillUnitRef

balanceGroups

List<BalanceGroup> balanceGroups

bdomChangeStatus

Integer bdomChangeStatus

The status of the billing day-of-month (DOM) change. Can be one of the following:

• -1: Does not exist
• 0: New
• 1: In progress
• 2: Failed
• 3: Completed
• 4: Update is pending (for child billinfos awaiting update)

bdomJobCompletion

Calendar bdomJobCompletion

The time the billing day-of-month (DOM) change job was completed, if applicable.

bdomJobFlag

Integer bdomJobFlag

Whether the billing day of month (DOM) changes for member accounts should be executed immediately (1) or deferred (2). This flag applies only to parent accounts' bill units that have a business profile with the AsyncBDOMChange key set to yes. If a value is not sent, the job will be deferred (as with a value of 2).

billForCurrentCycleRef

ResourceRef billForCurrentCycleRef

billingCycleEnd

Calendar billingCycleEnd

The date and time the billing cycle ends.

billingCycleStart

Calendar billingCycleStart

The date and time the billing cycle starts

billingFrequencyInMonths

Integer billingFrequencyInMonths

The billing frequency in number of months. Can be one of the following:

• 1: Monthly
• 2: Bi-monthly
• 3: Quarterly
• 12: Yearly

businessProfile

String businessProfile

The business profile associated with bill unit.

collectionDate

Calendar collectionDate

The date collections is due.

collectionDetailsRef

ResourceRef collectionDetailsRef

correctiveInvoiceType

Integer correctiveInvoiceType

The type of invoice to create for corrective bills, such as an invoice correction letter or a replacement invoice.

creationDate

Calendar creationDate

The date and time the bill unit was created.

currency

int currency

The bill unit's primary currency.

currencySecondary

Integer currencySecondary

The bill unit's secondary currency.

daysInBillCycle

Integer daysInBillCycle

The number of days in a billing cycle.

daysRemainingInBillCycle

Integer daysRemainingInBillCycle

The number of days that remain in the current billing cycle.

defaultBillUnit

Boolean defaultBillUnit

Whether this is the default bill unit (true) or not (false).

exemptFromCollections

Integer exemptFromCollections

Whether the bill unit is exempt from collections or not.

id

String id

The ID.

inCollections

Boolean inCollections

Whether the bill unit is in collections (true) or not (false).

invoiceTemplate

String invoiceTemplate

The name of the invoice template associated with the bill unit.

lastActualBillDate

Calendar lastActualBillDate

The date and time the last bill was created.

lastActualBillRef

ResourceRef lastActualBillRef

lastBillFromBillingRef

ResourceRef lastBillFromBillingRef

lastModified

Calendar lastModified

The date and time the bill unit was last modified.

name

String name

The bill unit's name.

numSuppressedCycles

Integer numSuppressedCycles

The number of consecutive billing cycles that the bill unit has been suppressed.

parentAccountId

String parentAccountId

The ID of this bill unit's parent account.

parentAccountNumber

String parentAccountNumber

The account number associated with the parent's bill unit.

parentBillUnit

Boolean parentBillUnit

Whether this is a parent bill unit (true) or not (false).

parentBillUnitName

String parentBillUnitName

The name of this bill unit's parent bill unit.

parentCompanyName

String parentCompanyName

The parent bill unit's company name.

parentFirstName

String parentFirstName

The first name associated with the parent bill unit.

parentLastName

String parentLastName

The last name associated with the parent bill unit.

parentSalutation

String parentSalutation

The parent bill unit's salutation, such as Mr. or Mx.

paymentInstrumentName

String paymentInstrumentName

The name of the payment instrument.

paymentInstrumentRef

ResourceRef paymentInstrumentRef

paymentMethod

PaymentMethod paymentMethod

paymentType

Integer paymentType

The payment type. Can be one of the following:

• 10001:Invoice
• 10003: Credit card
• 10005: Direct debit
• 10007: Subordinate

rollUp

Boolean rollUp

scenarioRef

ResourceRef scenarioRef

segment

String segment

The customer segment associated with the bill unit. A customer segment is a user-defined customer description that can be used to group accounts according to customer billing and payment practices.

status

String status

The status of the bill unit: defunct (0), active (10100), inactive (10102), or closed (10103)

suppressed

Integer suppressed

Whether the bill unit is suppressed or not.

suppressionCyclesLeft

Integer suppressionCyclesLeft

The number of consecutive billing cycles for which the bill is to be suppressed.

totalChildAccounts

Integer totalChildAccounts

The total number of child accounts.

totalChildBillUnits

Integer totalChildBillUnits

The total number of child bill units.

wholesaleBilling

String wholesaleBilling

The wholesale billing key.

Class com.oracle.communications.brm.cc.model.BillUnitHierarchy

class BillUnitHierarchy extends Extension implements Serializable

Serialized Fields

arBillUnitRef

ResourceRef arBillUnitRef

billCurrentDue

Boolean billCurrentDue

The current amount due.

billUnitId

String billUnitId

The ID of this bill unit.

notes

Notes notes

parentBillUnitId

String parentBillUnitId

The ID of parent bill unit.

paymentInstrumentRef

ResourceRef paymentInstrumentRef

rollUp

Boolean rollUp

Class com.oracle.communications.brm.cc.model.Bundle

class Bundle extends Extension implements Serializable

Serialized Fields

bundleId

String bundleId

The ID of the bundle.

chargeoffers

List<Bundle.Chargeoffers> chargeoffers

The list of charge offers in the bundle.

creationDate

Calendar creationDate

The date and time the bundle was created.

description

String description

The bundle's description.

discountoffers

List<Bundle.Discountoffers> discountoffers

The list of discount offers in the bundle.

name

String name

The name of the bundle.

packageId

String packageId

permitted

String permitted

The purchase level permitted for the bundle. This can be a single service (for example, /service/email), all services (/service), all accounts (/account), or all accounts and services (*).

ref

ResourceRef ref

service

Bundle.Service service

A service associated with the bundle.

subscriptionTerms

SubscriptionTerms subscriptionTerms

tags

String tags

The tags associated with the bundle.

validTo

Calendar validTo

The date and time the validity period ends.

Class com.oracle.communications.brm.cc.model.Bundle.Chargeoffers

class Chargeoffers extends Object implements Serializable

Serialized Fields

baseProductCode

String baseProductCode

The code of the base product of the charge offer.

baseProductName

String baseProductName

The name of the base product of the charge offer.

baseProductRef

ResourceRef baseProductRef

description

String description

The charge offer's description.

gracePeriodOffset

Integer gracePeriodOffset

The number to offset the grace period by.

gracePeriodUnit

Integer gracePeriodUnit

The unit the grace period is measured in.

name

String name

The name of the charge offer.

offerAttributeGroupRef

ResourceRef offerAttributeGroupRef

offerAttributes

OfferAttributes offerAttributes

ref

ResourceRef ref

renewalMode

Integer renewalMode

How to handle the charge offer's cycle alignment when its bundle is reactivated. Valid values:

• 0: Cycle aligns with the original billing date or configured specific day of the month.
• 1: Cycle aligns with the reactivation date.

validityAlignMode

Integer validityAlignMode

This shows if the product is an addon product and alignment of validity with other products.

Class com.oracle.communications.brm.cc.model.Bundle.Discountoffers

class Discountoffers extends Object implements Serializable

Serialized Fields

description

String description

The discount offer's description.

name

String name

The name of the discount offer.

offerAttributeGroupRef

ResourceRef offerAttributeGroupRef

offerAttributes

OfferAttributes offerAttributes

ref

ResourceRef ref

Class com.oracle.communications.brm.cc.model.Bundle.Service

class Service extends Object implements Serializable

Serialized Fields

aliasList

List<Bundle.Service.AliasList> aliasList

The list of aliases associated with the service.

login

String login

The login associated with the service.

serviceId

ResourceRef serviceId

serviceKey

String serviceKey

The service key.

serviceType

String serviceType

The service type.

status

Integer status

The status.

Class com.oracle.communications.brm.cc.model.Bundle.Service.AliasList

class AliasList extends Object implements Serializable

Serialized Fields

elem

Integer elem

name

String name

Class com.oracle.communications.brm.cc.model.BundleCancel

class BundleCancel extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

A reference to the account.

dealRef

ResourceRef dealRef

A reference to the deal.

description

String description

The product's description.

effective

Calendar effective

The date and time the status takes effect.

flag

Integer flag

flag.

packageId

int packageId

The ID of the package.

serviceRef

ResourceRef serviceRef

A reference to the service.

Class com.oracle.communications.brm.cc.model.BundleList

class BundleList extends Extension implements Serializable

Serialized Fields

bundle

List<Bundle> bundle

A bundle.

Class com.oracle.communications.brm.cc.model.BundleOffers

class BundleOffers extends Object implements Serializable

Serialized Fields

bundleOffer

List<BundleOffers.BundleOffer> bundleOffer

A bundle.

Class com.oracle.communications.brm.cc.model.BundleOffers.BundleOffer

class BundleOffer extends Object implements Serializable

Serialized Fields

bundleId

String bundleId

The ID of the bundle.

chargeoffers

List<BundleOffers.BundleOffer.Chargeoffers> chargeoffers

A list of charge offers.

discountoffers

List<BundleOffers.BundleOffer.Discountoffers> discountoffers

A list of discount offers.

name

String name

The name of the bundle.

packageId

String packageId

The ID of the package.

Class com.oracle.communications.brm.cc.model.BundleOffers.BundleOffer.Chargeoffers

class Chargeoffers extends Object implements Serializable

Serialized Fields

chargeRef

ResourceRef chargeRef

description

String description

The charge offer's description.

isRequired

boolean isRequired

Whether the charge offer is required (true) or not (false).

lastStatusChange

Calendar lastStatusChange

The date and time the charge offer's status was last changed.

name

String name

The charge offer's name.

status

String status

The charge offer's status.

Class com.oracle.communications.brm.cc.model.BundleOffers.BundleOffer.Discountoffers

class Discountoffers extends Object implements Serializable

Serialized Fields

description

String description

The discount offer's description.

discountRef

ResourceRef discountRef

isRequired

boolean isRequired

Whether the discount offer is required (true) or not (false).

lastStatusChange

Calendar lastStatusChange

The date and time the discount offer's status was last changed.

name

String name

The discount offer's name.

status

String status

The discount offer's status.

Class com.oracle.communications.brm.cc.model.BundleTransition

class BundleTransition extends Extension implements Serializable

Serialized Fields

fromBundle

String fromBundle

The old bundle that the customer is transitioning from.

notes

Notes notes

service

BundleTransition.Service service

A service associated with the bundle.

toBundle

String toBundle

The new bundle that the customer is transitioning to.

transitionType

int transitionType

The transition type, such as an upgrade or downgrade. Use the keys returned by the Get Transition Types endpoint.

Class com.oracle.communications.brm.cc.model.BundleTransition.Service

class Service extends Object implements Serializable

Serialized Fields

id

String id

The service poid.

login

String login

The service login.

Class com.oracle.communications.brm.cc.model.BusinessProfiles

class BusinessProfiles extends Extension implements Serializable

Serialized Fields

asyncBDOMChangeFlag

Boolean asyncBDOMChangeFlag

Whether the business profile supports making changes to the billing day of month (DOM) through a separate job (true) or not, meaning that changes are made to parent and member accounts in single API call, synchronously (false).

id

String id

The business profile's ID.

name

String name

The business profile's name.

Class com.oracle.communications.brm.cc.model.CancelInstallment

class CancelInstallment extends Object implements Serializable

Serialized Fields

completedAt

String completedAt

The completion date and time of the operation.

createdAt

String createdAt

The date of creation.

customerRef

String customerRef

The customer reference.

error

String error

The error message for any details or corrective actions.

href

String href

The unique resource URL, used for getting the object.

id

String id

The ID of the installment schedule to cancel.

installmentRef

String installmentRef

The installment schedule reference.

notes

String notes

Notes about the cancellation.

reason

String reason

The reason for cancellation.

status

String status

The status of the installment schedule cancelation.
Allowed Values: COMPLETED, FAILED, PENDING

Class com.oracle.communications.brm.cc.model.ChangeValidity

class ChangeValidity extends AractionBaseType implements Serializable

Serialized Fields

balanceGroupId

String balanceGroupId

The ID of the balance group associated with the date change.

elementId

int elementId

The ID of the element associated with the date change.

validTo

Calendar validTo

The new validity end date.

Class com.oracle.communications.brm.cc.model.ChargeOfferType

class ChargeOfferType extends Extension implements Serializable

Serialized Fields

creationDate

Calendar creationDate

The charge offer's creation date.

cycleDiscount

BigDecimal cycleDiscount

The charge offer's cycle discount.

cycleEnd

EndingType cycleEnd

cycleStart

StartingType cycleStart

description

String description

The charge offer's description.

ends

Calendar ends

The date and time the charge offer's validity ends.

forServiceType

String forServiceType

The type of service the charge offer can be associated with.

id

String id

The ID.

lastModified

Calendar lastModified

The date and time the charge offer was last modified.

name

String name

The charge offer's name.

purchaseDiscount

Object purchaseDiscount

The charge offer's purchase discount.

quantity

BigDecimal quantity

The charge offer's quantity.

starts

Calendar starts

The date and time the charge offer's validity starts.

status

String status

The charge offer's status.

statusFlags

Integer statusFlags

The status flags.

usageDiscount

BigDecimal usageDiscount

The charge offer's usage discount.

usageEnd

EndingType usageEnd

usageStart

StartingType usageStart

Class com.oracle.communications.brm.cc.model.Children

class Children extends AccountContactDetails implements Serializable

Class com.oracle.communications.brm.cc.model.CollectionDetails

class CollectionDetails extends Extension implements Serializable

Serialized Fields

actions

List<CollectionDetails.Actions> actions

List of collections actions.

agingBuckets

List<CollectionDetails.AgingBuckets> agingBuckets

List of aging buckets.

billUnitId

String billUnitId

The ID of the bill unit.

minimumDue

BigDecimal minimumDue

The minimum payment amount.

notes

Notes notes

overdueAmount

BigDecimal overdueAmount

The amount that is past due.

overdueDays

int overdueDays

The number of days that the payment is past due.

scenarioId

String scenarioId

The ID of the collections scenario.

Class com.oracle.communications.brm.cc.model.CollectionDetails.Actions

class Actions extends Object implements Serializable

Serialized Fields

action

String action

The collections action's name.

actionId

String actionId

The ID of the collections action.

completedDate

Calendar completedDate

The date and time the collections action was completed.

dueDate

Calendar dueDate

The date and time the collections action is due.

status

Integer status

The status of the collections action: 0 (Pending) , 1 (Canceled), 2 (Completed), 3 (Error), and 4 (No execute).

Class com.oracle.communications.brm.cc.model.CollectionDetails.AgingBuckets

class AgingBuckets extends Object implements Serializable

Serialized Fields

days

int days

The number of overdue days in this aging bucket.

due

BigDecimal due

The amount due in this aging bucket.

Class com.oracle.communications.brm.cc.model.CollectionsActionHistory

class CollectionsActionHistory extends Extension implements Serializable

Serialized Fields

actionHistory

List<CollectionsActionHistory.ActionHistory> actionHistory

The list of collections action activities.

actionId

String actionId

The ID of the collections action.

Class com.oracle.communications.brm.cc.model.CollectionsActionHistory.ActionHistory

class ActionHistory extends Object implements Serializable

Serialized Fields

agentName

String agentName

The name of the agent that performed the collections action.

changeDate

Calendar changeDate

The date and time there was a change to the collections action.

description

String description

The description of the collections action.

dueDate

Calendar dueDate

The date and time the collections action is due.

status

int status

The status of the collections action: 0 (Action pending), 1 (Action canceled), 2 (Action completed), or 3 (Action error).

Class com.oracle.communications.brm.cc.model.CollectionsExemptedBillUnits

class CollectionsExemptedBillUnits extends Extension implements Serializable

Serialized Fields

accountId

String accountId

The ID of the account.

accountNumber

String accountNumber

The account number.

billUnitId

String billUnitId

The ID of the bill unit.

billUnitName

String billUnitName

The bill unit's name.

firstName

String firstName

The customer's first name.

lastName

String lastName

The customer's last name.

Class com.oracle.communications.brm.cc.model.CollectionsGroup

class CollectionsGroup extends Extension implements Serializable

Serialized Fields

members

List<CollectionsGroup.Members> members

The list of members in the collections sharing group.

name

String name

The name of the collections sharing group.

newParentBillUnitRef

ResourceRef newParentBillUnitRef

notes

Notes notes

parentBillUnitDue

BigDecimal parentBillUnitDue

The amount owed by the collections sharing group owner.

parentBillUnitRef

ResourceRef parentBillUnitRef

Class com.oracle.communications.brm.cc.model.CollectionsGroup.Members

class Members extends Object implements Serializable

Serialized Fields

accountNumber

String accountNumber

The account number of the collections sharing group member.

accountRef

ResourceRef accountRef

amountDue

BigDecimal amountDue

The amount owed by the collections sharing group member.

billUnitName

String billUnitName

The name of the collections sharing group member's bill unit.

billUnitRef

ResourceRef billUnitRef

firstName

String firstName

The collections sharing group member's first name.

lastName

String lastName

The collections sharing group member's last name.

Class com.oracle.communications.brm.cc.model.CollectionsGroupDetails

class CollectionsGroupDetails extends Extension implements Serializable

Serialized Fields

groupMembers

List<CollectionsGroupDetails.GroupMembers> groupMembers

Details about the members of a collections sharing group.

groupOwners

List<CollectionsGroupDetails.GroupOwners> groupOwners

A collections sharing group owner.

Class com.oracle.communications.brm.cc.model.CollectionsGroupDetails.GroupMembers

class GroupMembers extends Object implements Serializable

Serialized Fields

billUnitName

String billUnitName

The name of the bill associated with the collections sharing group.

billUnitRef

ResourceRef billUnitRef

groupName

String groupName

The name of the sharing group.

parentAccountNumber

String parentAccountNumber

The account number associated with the parent bill unit of the collections sharing group.

parentAccountRef

ResourceRef parentAccountRef

parentBillUnitName

String parentBillUnitName

The name of the parent bill unit associated with the collections sharing group.

parentBillUnitRef

ResourceRef parentBillUnitRef

Class com.oracle.communications.brm.cc.model.CollectionsGroupDetails.GroupOwners

class GroupOwners extends Object implements Serializable

Serialized Fields

billUnitName

String billUnitName

The name of the bill unit associated with the collections sharing group.

billUnitRef

ResourceRef billUnitRef

groupName

String groupName

The name of the collections sharing group.

groupRef

ResourceRef groupRef

memberCount

Integer memberCount

The number of members in the collections sharing group.

Class com.oracle.communications.brm.cc.model.ColumnarRecord

class ColumnarRecord extends Extension implements Serializable

Serialized Fields

columnDefinitions

List<ColumnarRecord.ColumnDefinitions> columnDefinitions

entries

List<ColumnarRecord.Entries> entries

saveResults

Boolean saveResults

templateName

String templateName

xmlTemplateName

String xmlTemplateName

Class com.oracle.communications.brm.cc.model.ColumnarRecord.ColumnDefinitions

class ColumnDefinitions extends Object implements Serializable

Serialized Fields

alignment

String alignment

icon

Boolean icon

label

String label

name

String name

resizable

Boolean resizable

sortable

Boolean sortable

tooltip

String tooltip

visible

Boolean visible

width

String width

Class com.oracle.communications.brm.cc.model.ColumnarRecord.Entries

class Entries extends Object implements Serializable

Serialized Fields

cells

List<ColumnarRecord.Entries.Cells> cells

nonCurrencyCells

List<ColumnarRecord.Entries.NonCurrencyCells> nonCurrencyCells

recordId

String recordId

Class com.oracle.communications.brm.cc.model.ColumnarRecord.Entries.Cells

class Cells extends Object implements Serializable

Serialized Fields

args

List<String> args

format

List<String> format

name

String name

styles

List<String> styles

type

String type

types

List<String> types

Class com.oracle.communications.brm.cc.model.ColumnarRecord.Entries.NonCurrencyCells

class NonCurrencyCells extends Object implements Serializable

Serialized Fields

name

String name

recordId

List<String> recordId

Class com.oracle.communications.brm.cc.model.ConfigCollectionAction

class ConfigCollectionAction extends Extension implements Serializable

Serialized Fields

actionDescription

String actionDescription

Action description.

actionName

String actionName

Action name to be displayed on GUI tools

actionType

String actionType

The action type string.

opcode

Integer opcode

Opcode (ID) to be called for this action.

targetAction

Integer targetAction

To which billinfos this action targetted to. Values can be 0,1 and 2.

Class com.oracle.communications.brm.cc.model.ConfigPromiseToPaySpecification

class ConfigPromiseToPaySpecification extends Object implements Serializable

Serialized Fields

name

String name

promiseToPaySpec

ConfigPromiseToPaySpecification.PromiseToPaySpec promiseToPaySpec

Class com.oracle.communications.brm.cc.model.ConfigPromiseToPaySpecification.PromiseToPaySpec

class PromiseToPaySpec extends Object implements Serializable

Serialized Fields

creditLimitFlag

int creditLimitFlag

Specify whether to increment or decrement the credit limit (1) or not (0).

maxUnequalInstallments

int maxUnequalInstallments

The maximum number of unequal installments.

maxUnequalInterval

int maxUnequalInterval

The maximum interval between installments.

minimum

BigDecimal minimum

Minimum value per installment.

minPercentageThreshold

BigDecimal minPercentageThreshold

The minimum value of the first installment.

type

int type

The type of minimum value. Allowed Values:

• 0 (Absolute)
• 1 (Percentage)

Class com.oracle.communications.brm.cc.model.ConfigSubscriberPreferencesType

class ConfigSubscriberPreferencesType extends Object implements Serializable

Serialized Fields

subscriberPreferencesType

ConfigSubscriberPreferencesType.SubscriberPreferencesType subscriberPreferencesType

Class com.oracle.communications.brm.cc.model.ConfigSubscriberPreferencesType.SubscriberPreferencesType

class SubscriberPreferencesType extends Object implements Serializable

Serialized Fields

_default

String _default

name

String name

stringId

int stringId

stringVersion

int stringVersion

subscriberPreferenceId

int subscriberPreferenceId

type

int type

values

List<ConfigSubscriberPreferencesType.SubscriberPreferencesType.Values> values

Class com.oracle.communications.brm.cc.model.ConfigSubscriberPreferencesType.SubscriberPreferencesType.Values

class Values extends Object implements Serializable

Serialized Fields

stringId

int stringId

stringVersion

int stringVersion

value

String value

Class com.oracle.communications.brm.cc.model.Configurations

class Configurations extends Extension implements Serializable

Serialized Fields

flags

List<Configurations.Flags> flags

A flag.

keyvals

List<Configurations.Keyvals> keyvals

A set of key-value pairs.

mapping

List<Configurations.Mapping> mapping

A mapping.

thresholds

List<Configurations.Thresholds> thresholds

A threshold. The minimum required parameters are: key and value.

Class com.oracle.communications.brm.cc.model.Configurations.Flags

class Flags extends Object implements Serializable

Serialized Fields

desc

String desc

A description of the flag.

key

String key

The name of the flag.

value

boolean value

The value associated with the flag, which can be true or false.

version

String version

The version of the flag.

Class com.oracle.communications.brm.cc.model.Configurations.Keyvals

class Keyvals extends Object implements Serializable

Serialized Fields

desc

String desc

The key-value pair's description.

key

String key

The key name.

value

String value

The value.

version

String version

The version of the key-value pair.

Class com.oracle.communications.brm.cc.model.Configurations.Mapping

class Mapping extends Object implements Serializable

Serialized Fields

desc

String desc

The mapping's description.

key

String key

The mapping's key.

map

List<Configurations.Mapping.Map> map

A map.

version

String version

The version of the mapping.

Class com.oracle.communications.brm.cc.model.Configurations.Mapping.Map

class Map extends Object implements Serializable

Serialized Fields

id

String id

The map ID.

key

String key

The key.

Class com.oracle.communications.brm.cc.model.Configurations.Thresholds

class Thresholds extends Object implements Serializable

Serialized Fields

desc

String desc

The description of the threshold.

key

String key

Unique name for configuration acting as an upper limit for pagination size, number of records to fetch, timeouts, etc.

value

int value

The threshold value.

version

String version

The version of the threshold.

Class com.oracle.communications.brm.cc.model.Contacts

class Contacts extends Object implements Serializable

Serialized Fields

address

String address

The customer's address.

city

String city

The customer's city.

company

String company

The company name.

contactType

String contactType

The contact type.

country

String country

The customer's country.

deleted

Boolean deleted

Whether to delete the contact (true) or not (false). This must be set to false if you adding a contact.

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

emailAddress

String emailAddress

The customer's email address.

firstName

String firstName

The customer's first name.

lastName

String lastName

The customer's last name.

middleName

String middleName

The customer's middle name.

newlyCreated

boolean newlyCreated

Whether the contact information was newly created (true) or not (false).

phonenumbers

List<Contacts.Phonenumbers> phonenumbers

The list of associated phone numbers.

salutation

String salutation

The salutation to use use with the customer, such as Mr. or Miss.

state

String state

The customer's state.

title

String title

The customer's job title.

zip

String zip

The ZIP code.

Class com.oracle.communications.brm.cc.model.Contacts.Phonenumbers

class Phonenumbers extends Object implements Serializable

Serialized Fields

deleted

boolean deleted

Whether to delete the phone number (true) or not (false). This must be set to false if you adding a phone number.

newlyCreated

boolean newlyCreated

Whether the phone number was newly created (true) or not (false).

number

String number

The phone number.

phonetype

Integer phonetype

The type of phone number.

Class com.oracle.communications.brm.cc.model.ContractPreviewCancellationCharge

class ContractPreviewCancellationCharge extends Object implements Serializable

Serialized Fields

cancellationChargeType

int cancellationChargeType

The type of cancelation fee. Can be one of the following:

• 0: Fixed
• 1: Reducing

cancellationFee

BigDecimal cancellationFee

The cancellation fee.

subscriberContractRef

ResourceRef subscriberContractRef

Class com.oracle.communications.brm.cc.model.CorrectiveBill

class CorrectiveBill extends Extension implements Serializable

Serialized Fields

invoiceFormat

int invoiceFormat

The invoice format. Can be one of the following:

• 1: Detail
• 2: Summary

invoiceType

int invoiceType

The invoice type. Can be one of the following:

• 1: Correction letter
• 2: Replacement invoice

notes

Notes notes

Class com.oracle.communications.brm.cc.model.CorrectiveBillDetails

class CorrectiveBillDetails extends Extension implements Serializable

Serialized Fields

adjusted

BigDecimal adjusted

The amount of any adjustments.

arActionsAmtExcludingPayments

BigDecimal arActionsAmtExcludingPayments

The total amount of all accounts receivable actions, excluding any payments.

billNo

String billNo

The bill number.

creationDate

Calendar creationDate

The date and time the corrective bill was created.

currentTotal

BigDecimal currentTotal

The current total amount due.

disputed

BigDecimal disputed

The amount of any disputes.

due

BigDecimal due

The amount due for the corrective bill.

dueDate

Calendar dueDate

The date and time the corrective bill is due.

invoiceFormat

Integer invoiceFormat

The invoice format. Can be one of the following:

• 1: Detail
• 2: Summary

invoiceType

Integer invoiceType

The invoice type. Can be one of the following:

• 1: Correction letter
• 2: Replacement invoice

receivedForBill

BigDecimal receivedForBill

The payment received against the original bill.

subordsTotal

BigDecimal subordsTotal

The total amount due for all subordinate accounts.

totalDue

BigDecimal totalDue

The total amount due for the parent account and all child accounts.

Class com.oracle.communications.brm.cc.model.CorrectiveBillTrail

class CorrectiveBillTrail extends CorrectiveBillDetails implements Serializable

Serialized Fields

notes

Notes notes

originalBill

OriginalBill originalBill

Information about an original bill.

Class com.oracle.communications.brm.cc.model.CreditCardType

class CreditCardType extends PaymentInstrumentType implements Serializable

Serialized Fields

details

CreditCardType.Details details

The credit card details.

Class com.oracle.communications.brm.cc.model.CreditCardType.Details

class Details extends Object implements Serializable

Serialized Fields

address

String address

The street address associated with the credit card.

city

String city

The city associated with the credit card.

country

String country

The country associated with the credit card.

debitExp

String debitExp

The credit card expiry date in mmyy format.

debitNumber

String debitNumber

The credit card number.

name

String name

The name as it appears on the credit card.

securityCode

String securityCode

The credit card's 3-digit CVV2 or 4-digit CID.

state

String state

The state associated with the credit card.

zip

String zip

The ZIP code associated with the credit card.

Class com.oracle.communications.brm.cc.model.CreditLimit

class CreditLimit extends Extension implements Serializable

Serialized Fields

dynamicFloor

Boolean dynamicFloor

Whether to use a dynamic credit floor (true) or not (false). The default is false.

fixedThresholds

String fixedThresholds

The value of any fixed thresholds.

floor

BigDecimal floor

The credit floor, which is a number that indicates none of the balance has been used. For example, it specifies the allowance of minutes or gigabytes that you granted to a customer. For currency balances, the credit floor is 0.

limit

BigDecimal limit

The credit limit amount.

overrideCreditLimit

Integer overrideCreditLimit

Whether to override the credit limit. Allowed Values: 0 (Enforce Credit Limit) or 1 (Override credit limit).

resourceId

int resourceId

The resource ID.

rollUp

Boolean rollUp

tempCreditLimit

List<TempCreditLimit> tempCreditLimit

thresholds

String thresholds

The value of any percentage thresholds.

Class com.oracle.communications.brm.cc.model.CreditorInfo

class CreditorInfo extends Extension implements Serializable

Serialized Fields

creditorsDetails

List<CreditorInfo.CreditorsDetails> creditorsDetails

Details about a creditor.

Class com.oracle.communications.brm.cc.model.CreditorInfo.CreditorsDetails

class CreditorsDetails extends Object implements Serializable

Serialized Fields

address

String address

The creditor's address.

country

String country

The creditor's country.

creditorID

String creditorID

The ID for the creditor.

name

String name

The creditor's name.

Class com.oracle.communications.brm.cc.model.Criteria

class Criteria extends Object implements Serializable

Serialized Fields

_default

String _default

fieldGroups

List<Criteria.FieldGroups> fieldGroups

fieldKey

String fieldKey

fixedValues

List<Criteria.FixedValues> fixedValues

inputType

String inputType

join

String join

label

String label

name

String name

properties

List<Criteria.Properties> properties

spacer

Boolean spacer

storableClass

String storableClass

type

String type

visible

String visible

width

Integer width

Class com.oracle.communications.brm.cc.model.Criteria.FieldGroups

class FieldGroups extends Object implements Serializable

Serialized Fields

criteria

List<Criteria> criteria

groupLabel

String groupLabel

groupOperator

String groupOperator

Class com.oracle.communications.brm.cc.model.Criteria.FixedValues

class FixedValues extends Object implements Serializable

Serialized Fields

label

String label

value

String value

Class com.oracle.communications.brm.cc.model.Criteria.Properties

class Properties extends Object implements Serializable

Serialized Fields

key

String key

value

String value

Class com.oracle.communications.brm.cc.model.Criterias

class Criterias extends Object implements Serializable

Serialized Fields

field

String field

groups

List<Criterias.Groups> groups

name

String name

operator

String operator

value

String value

Class com.oracle.communications.brm.cc.model.Criterias.Groups

class Groups extends Object implements Serializable

Serialized Fields

criterias

List<Criterias> criterias

name

String name

Class com.oracle.communications.brm.cc.model.CustomerAssets

class CustomerAssets extends Object implements Serializable

Serialized Fields

billUnitServices

List<CustomerAssets.BillUnitServices> billUnitServices

Class com.oracle.communications.brm.cc.model.CustomerAssets.BillUnitServices

class BillUnitServices extends Object implements Serializable

Serialized Fields

billUnitID

String billUnitID

The bill unit's ID.

billUnitName

String billUnitName

The bill unit's name.

services

List<Service> services

Class com.oracle.communications.brm.cc.model.CustomerDeposit

class CustomerDeposit extends Object implements Serializable

Serialized Fields

balanceAmount

Money balanceAmount

billProfileRef

String billProfileRef

The bill profile reference.

code

String code

The external identifier.

createdAt

String createdAt

The date when the customer deposit is created.

customerRef

String customerRef

The customer reference.

depositSpecName

String depositSpecName

The deposit specification name.

depositSpecRef

String depositSpecRef

The deposit specification reference.

discountAmount

Money discountAmount

effectiveDate

String effectiveDate

The date from which the customer deposit is effective.

href

String href

The unique resource URL, used to get the object.

id

String id

The customer deposit ID.

interestAmount

Money interestAmount

modifiedAt

String modifiedAt

The date when the customer deposit is modified.

notes

String notes

The notes for the customer deposit.

receivedAmount

Money receivedAmount

releasedAmount

Money releasedAmount

releaseType

Integer releaseType

The release type. Allowed Values: 1 (Prepayment), 2 (Refund), 3 (Zeroise).

serviceRef

String serviceRef

The service reference.

status

String status

The deposit status. Allowed Values: WAITING, ACTIVE, EXPIRED, TRANSFERRED, RELEASED, REFUNDED, CANCELLED

totalAmount

Money totalAmount

transactions

List<CustomerDepositTransactions> transactions

validFor

TimePeriod validFor

validityRule

DepositValidityRule validityRule

Class com.oracle.communications.brm.cc.model.CustomerDepositTransactions

class CustomerDepositTransactions extends Object implements Serializable

Serialized Fields

transactionRef

String transactionRef

Reference to the transaction record.

transactions

String transactions

The transactions.

Class com.oracle.communications.brm.cc.model.CustomerPackages

class CustomerPackages extends Object implements Serializable

Serialized Fields

billUnitPackages

List<CustomerPackages.BillUnitPackages> billUnitPackages

A list of purchased packages

Class com.oracle.communications.brm.cc.model.CustomerPackages.BillUnitPackages

class BillUnitPackages extends Object implements Serializable

Serialized Fields

accountBundles

AccountGroup accountBundles

packageCreatedDate

Calendar packageCreatedDate

The date and time the package was created.

packageID

String packageID

The package's ID.

packageName

String packageName

The package's name.

packagePurchasedDate

Calendar packagePurchasedDate

The date and time the package was purchased.

packageTerms

SubscriptionTerms packageTerms

serviceType

List<ServiceGroup> serviceType

Class com.oracle.communications.brm.cc.model.CustomizedBundleForPurchase

class CustomizedBundleForPurchase extends Extension implements Serializable

Serialized Fields

creditLimitFlags

Integer creditLimitFlags

Flag to set credit limit options. Allowed Values: 1 (Override credit limit), 2 (Prorate based on credit limit), 64 (Enforce credit limit).

customizedChargeOffers

List<CustomizedBundleForPurchase.CustomizedChargeOffers> customizedChargeOffers

The list of customized charge offers in the bundle.

customizedDiscountOffers

List<CustomizedBundleForPurchase.CustomizedDiscountOffers> customizedDiscountOffers

The list of customized discount offers.

effective

Calendar effective

The date and time the bundle takes effect.

id

String id

The ID.

name

String name

The bundle's name.

notes

Notes notes

Class com.oracle.communications.brm.cc.model.CustomizedBundleForPurchase.CustomizedChargeOffers

class CustomizedChargeOffers extends Object implements Serializable

Serialized Fields

baseChargeOfferRef

ResourceRef baseChargeOfferRef

baseProductRef

ResourceRef baseProductRef

cycleAlignment

String cycleAlignment

cycle alignment.

cycleChargeType

String cycleChargeType

Cycle Charge type.

cycleDiscountOverride

BigDecimal cycleDiscountOverride

The fixed amount of the cycle discount override.

cycleDiscountPercentOverride

BigDecimal cycleDiscountPercentOverride

The percentage amount of the cycle discount override.

cycleEnd

EndingType cycleEnd

cycleFeeOverride

BigDecimal cycleFeeOverride

The amount of the cycle fee override.

cycleFrequency

String cycleFrequency

cycle frequency

cycleStart

StartingType cycleStart

cycleUnit

String cycleUnit

cycle unit

description

String description

The charge offer's description.

gracePeriodOffset

Integer gracePeriodOffset

The number to offset the grace period by.

gracePeriodUnit

Integer gracePeriodUnit

The unit for the grace period.

inAdvanceBillingFrequency

String inAdvanceBillingFrequency

in advance billing frequency.

inAdvanceBillingUnit

String inAdvanceBillingUnit

in advance billing unit

name

String name

The charge offer's name.

overriddenCharges

List<OverriddenCharges> overriddenCharges

The list of overridden charges.

purchaseDiscountOverride

BigDecimal purchaseDiscountOverride

The fixed amount of the purchase discount override.

purchaseDiscountPercentOverride

BigDecimal purchaseDiscountPercentOverride

The percentage amount of the purchase discount override.

purchaseEnd

EndingType purchaseEnd

purchaseFeeOverride

BigDecimal purchaseFeeOverride

The fixed amount of the purchase fee override.

purchaseStart

StartingType purchaseStart

quantity

int quantity

The quantity purchased.

renewalMode

Integer renewalMode

How to handle the charge offer's cycle alignment when its bundle is reactivated. Possible values are:

• 0: Cycle aligns with the original billing date or configured specific day of the month.
• 1: Cycle aligns with the reactivation date.

status

Integer status

The charge offer's status. Can be one of the following:

• 0: Not set
• 1: Active
• 2: Inactive
• 3: Canceled

statusFlag

Integer statusFlag

The status flag.

tieDiscountOffers

List<ResourceRef> tieDiscountOffers

tieID

String tieID

usageEnd

EndingType usageEnd

usagePercentOverride

BigDecimal usagePercentOverride

The percentage amount of the usage override.

usageStart

StartingType usageStart

validityAlignMode

String validityAlignMode

The validity align mode for a product. Can be one of the following:

• base: Align the validity with baseProductRef passed in request
• any_base_earliest: Aligns the validity dates with the active base charge offer that expires first.
• any_base_latest: Aligns the validity dates with the active base charge offer that expires last.
• any_earliest: Aligns the validity dates with the active charge offer that expires first.
• any_latest: Aligns the validity dates with the active charge offer that expires last.

Class com.oracle.communications.brm.cc.model.CustomizedBundleForPurchase.CustomizedDiscountOffers

class CustomizedDiscountOffers extends Object implements Serializable

Serialized Fields

baseDiscountOfferRef

ResourceRef baseDiscountOfferRef

cycleAlignment

String cycleAlignment

cycle alignment.

cycleChargeType

String cycleChargeType

Cycle Charge type.

cycleEnd

EndingType cycleEnd

cycleFrequency

String cycleFrequency

cycle frequency

cycleStart

StartingType cycleStart

cycleUnit

String cycleUnit

cycle unit

description

String description

The discount offer's description.

inAdvanceBillingFrequency

String inAdvanceBillingFrequency

in advance billing frequency.

inAdvanceBillingUnit

String inAdvanceBillingUnit

in advance billing unit

name

String name

The discount offer's name.

overriddenCharges

List<OverriddenCharges> overriddenCharges

The list of overridden charges.

purchaseEnd

EndingType purchaseEnd

purchaseStart

StartingType purchaseStart

quantity

BigDecimal quantity

The discount's quantity.

status

Integer status

The discount offer's status. Can be one of the following:

• 0: Not set
• 1: Active
• 2: Inactive
• 3: Canceled

statusFlag

Integer statusFlag

The status flag.

tieChargeOffers

List<ResourceRef> tieChargeOffers

tieID

String tieID

usageEnd

EndingType usageEnd

usageStart

StartingType usageStart

Class com.oracle.communications.brm.cc.model.CustomizedOffers

class CustomizedOffers extends Object implements Serializable

Serialized Fields

customizedOffer

List<CustomizedOffers.CustomizedOffer> customizedOffer

Class com.oracle.communications.brm.cc.model.CustomizedOffers.CustomizedOffer

class CustomizedOffer extends Object implements Serializable

Serialized Fields

contractEndDate

Calendar contractEndDate

The end date for the contract.

contractName

String contractName

The name of the contract.

contractRef

ResourceRef contractRef

contractStartDate

Calendar contractStartDate

The start date for the contract.

cycleAlignment

String cycleAlignment

cycle alignment.

cycleChargeType

String cycleChargeType

Cycle Charge type.

cycleDuration

int cycleDuration

The accounting cycle duration.

cycleEndT

Calendar cycleEndT

The date and time the cycle changes end.

cycleFrequency

String cycleFrequency

cycle frequency

cycleStartT

Calendar cycleStartT

The date and time the cycle changes start.

cycleUnit

String cycleUnit

cycle unit

dealName

String dealName

The name of the deal that contains the offer.

dealRef

ResourceRef dealRef

A reference to the deal.

description

String description

The offer's description.

gracePeriodOffset

Integer gracePeriodOffset

The number to offset the grace period by.

gracePeriodUnit

Integer gracePeriodUnit

The unit the grace period is measured in.

id

String id

The ID.

inAdvanceBillingFrequency

String inAdvanceBillingFrequency

in advance billing frequency.

inAdvanceBillingUnit

String inAdvanceBillingUnit

in advance billing unit

name

String name

The offer's name.

overriddenCharges

List<OverriddenCharges> overriddenCharges

The list of overridden charges.

packageId

int packageId

The package id of offer.

planName

String planName

The name of the package that contains the offer.

planRef

ResourceRef planRef

A reference to the plan.

purchasedDate

Calendar purchasedDate

The date on which the offer is purchased.

purchaseDiscount

BigDecimal purchaseDiscount

The amount of the purchase fee discount.

purchaseDiscountPercent

BigDecimal purchaseDiscountPercent

The percentage amount by which to discount the purchase fee.

purchasedProductRef

ResourceRef purchasedProductRef

purchaseEndT

Calendar purchaseEndT

The date and time the purchase changes end.

purchaseFee

BigDecimal purchaseFee

The purchase fee amount.

purchaseFeeOverriden

BigDecimal purchaseFeeOverriden

The amount by which to override the purchase fee.

purchaseStartT

Calendar purchaseStartT

The date and time the purchase changes start.

quantity

BigDecimal quantity

The quantity of offer.

recurringDiscount

BigDecimal recurringDiscount

The fixed amount of the recurring discount.

recurringDiscountPercent

BigDecimal recurringDiscountPercent

The percentage amount of the recurring discount.

recurringFee

BigDecimal recurringFee

The amount of the recurring fee.

recurringFeeOverriden

BigDecimal recurringFeeOverriden

The amount by which to override the recurring fee.

renewalMode

Integer renewalMode

How to handle the offer's cycle alignment when its bundle is reactivated. Possible values are:

• 0: Cycle aligns with the original billing date or configured specific day of the month.
• 1: Cycle aligns with the reactivation date.

serviceName

String serviceName

The name of the service that contains the offer.

serviceRef

ResourceRef serviceRef

A reference to the service.

serviceType

String serviceType

The type of the service that contains the offer.

status

String status

The offer's status.

terminationFee

BigDecimal terminationFee

The amount of the early termination fee.

termRef

ResourceRef termRef

tiedOffer

Integer tiedOffer

tieID

String tieID

usageDiscount

BigDecimal usageDiscount

The amount of the usage discount.

usageEndT

Calendar usageEndT

The date and time the usage changes end.

usageStartT

Calendar usageStartT

The date and time the usage changes start.

Class com.oracle.communications.brm.cc.model.DDObjectSpec

class DDObjectSpec extends Object implements Serializable

Serialized Fields

className

String className

The storable class name.

descr

String descr

The storable class description.

fields

List<DDObjectSpecFields> fields

label

String label

The storable class label.

status

String status

The status of the storable class.

Class com.oracle.communications.brm.cc.model.DDObjectSpecFields

class DDObjectSpecFields extends Object implements Serializable

Serialized Fields

descr

String descr

The field's description.

fieldName

String fieldName

The field's name.

fields

List<DDObjectSpecFields> fields

fieldType

String fieldType

The field's data type.

label

String label

The field's label.

smItemName

String smItemName

The name of the table or collection.

Class com.oracle.communications.brm.cc.model.DeferredAction

class DeferredAction extends Extension implements Serializable

Serialized Fields

actionId

ResourceRef actionId

actionName

String actionName

The action's name.

actionStatus

int actionStatus

The status of the deferred action. Possible values are:

• 0: Pending
• 1: Done
• 2: Error
• 3: Pending and undeletable

description

String description

The deferred action's description.

isCollectionsAction

Boolean isCollectionsAction

Whether the deferred action is for collections (true) or not (false).

scheduledDate

Calendar scheduledDate

The date and time the deferred action is scheduled to occur.

serviceId

ResourceRef serviceId

serviceLogin

String serviceLogin

The service login information.

serviceType

String serviceType

The type of the service associated with the action.

Class com.oracle.communications.brm.cc.model.DeliveryMethod

class DeliveryMethod extends Object implements Serializable

Serialized Fields

id

String id

The delivery method ID.

name

String name

The delivery method name.

status

String status

The delivery status. Allowed values: ACTIVE, INACTIVE

Class com.oracle.communications.brm.cc.model.DepositAOC

class DepositAOC extends Object implements Serializable

Serialized Fields

amount

Money amount

billProfileRef

String billProfileRef

The bill profile reference.

customerRef

String customerRef

The customer reference.

depositSpecRef

String depositSpecRef

The deposit specification reference.

effectiveDate

String effectiveDate

The effective date for the advice-of-charge deposit.

href

String href

The unique resource URL, used to get the object.

id

String id

The ID of the deposit.

serviceRef

String serviceRef

The service reference.

startsAt

String startsAt

The date when the advice-of-charge starts.

validFor

TimePeriod validFor

Class com.oracle.communications.brm.cc.model.DepositInterestRule

class DepositInterestRule extends Object implements Serializable

Serialized Fields

glCode

Integer glCode

The general ledger ID.

interestFrequencyUnit

Integer interestFrequencyUnit

The unit of measure for the interest frequency.
Allowed Values:

• 0 (Month)
• 1 (Day)
• 2 (Week)
• 3 (Year)

Default value: 0

interestFrequencyValue

Integer interestFrequencyValue

The interest frequency.

interestRate

BigDecimal interestRate

The deposit interest rate.

interestType

Integer interestType

The deposit interest type.

• 0 (Simple)
• 1 (Compound)
• 2 (Absolute)
• 3 (Invalid zero error)

startInterestFrom

Integer startInterestFrom

The date when interest starts on the deposit. Allowed Values:

• 0 (Partial payment)
• 1 (Full payment)

Class com.oracle.communications.brm.cc.model.DepositOrder

class DepositOrder extends Object implements Serializable

Serialized Fields

customerDeposit

CustomerDeposit customerDeposit

payments

List<DepositPayment> payments

Class com.oracle.communications.brm.cc.model.DepositPayment

class DepositPayment extends Object implements Serializable

Serialized Fields

completedAt

String completedAt

The deposit payment completion date.

createdAt

String createdAt

The date when the deposit payment is created.

currency

Integer currency

The code for the payment's currency.

customerDepositRef

String customerDepositRef

The customer deposit reference.

customerRef

String customerRef

The customer reference.

glCode

String glCode

The general ledger ID.

href

String href

The unique resource URL, used to get the object.

id

String id

The deposit payment ID.

notes

String notes

Notes about the deposit payment.

payinfoTypeObject

PaymentTypeBase payinfoTypeObject

paymentAmount

Money paymentAmount

paymentMethodType

Integer paymentMethodType

The payment method type. Allowed Values:

• 10011 (Cash payment batch)
• 10012 (Check payment batch)
• 10013 (Wire-transfer payment batch)
• 10014 (Inter-bank payment order payment batch)
• 10015 (Postal order payment batch)
• 10017 (Failed payment batch)

paymentRef

String paymentRef

The payment reference.

status

Integer status

The deposit payment status. Allowed Values: 1 (Completed), 2 (Failed), 3 (Pending).

Class com.oracle.communications.brm.cc.model.DepositPayments

class DepositPayments extends Object implements Serializable

Serialized Fields

customerDepositRef

String customerDepositRef

The customer deposit reference.

customerRef

String customerRef

The customer reference.

notes

String notes

Notes about the deposit payment.

payments

List<DepositPayment> payments

Class com.oracle.communications.brm.cc.model.DepositRefund

class DepositRefund extends Object implements Serializable

Serialized Fields

accountNumber

String accountNumber

The account number.

approvedRefundAmount

Money approvedRefundAmount

completedAt

String completedAt

The deposit refund completion date.

createdAt

String createdAt

The date when the deposit refund is initiated.

customerDepositRef

String customerDepositRef

The customer deposit reference.

customerRef

String customerRef

The customer reference.

error

String error

Error message for the deposit refund.

glCode

String glCode

The general ledger ID.

href

String href

The unique resource URL, used to get the object.

id

String id

The deposit refund ID.

modifiedAt

String modifiedAt

The date when the deposit refund is modified.

notes

String notes

Notes about the deposit refund.

reason

String reason

Reason for the deposit refund.

refundAmount

Money refundAmount

refundRef

String refundRef

The deposit refund reference.

serviceRef

String serviceRef

The service reference.

status

Integer status

The deposit refund status. Allowed Values:

• 0 (Completed)
• 1 (Failed)
• 2 (Pending)
• 3 (Accepted)
• 4 (Rejected)

Class com.oracle.communications.brm.cc.model.DepositRefundRule

class DepositRefundRule extends Object implements Serializable

Serialized Fields

glCode

Integer glCode

The general ledger ID.

handlingFee

Money handlingFee

handlingFeeType

Integer handlingFeeType

The handling fee type.
Allowed Values: PERCENTAGE, ABSOLUTE

hasWorkFlow

Boolean hasWorkFlow

Specify whether the deposit refund has a workflow (true) or not (false).

id

int id

The ID of the deposit refund rule.

minRefundAmount

Money minRefundAmount

offsetPeriodUnit

String offsetPeriodUnit

The unit of measure for the offer period.
Allowed Values: DAY, WEEK, MONTH, YEAR

offsetPeriodValue

Integer offsetPeriodValue

The offer period value.

Class com.oracle.communications.brm.cc.model.DepositRelease

class DepositRelease extends Object implements Serializable

Serialized Fields

completedAt

String completedAt

The deposit release completion date.

createdAt

String createdAt

The date when the deposit release is initiated.

customerDepositRef

String customerDepositRef

The customer deposit reference.

customerRef

String customerRef

The customer reference.

error

String error

Error message for the deposit release.

glCode

String glCode

The general ledger ID.

href

String href

The unique resource URL, used to get the object.

id

String id

The deposit reference ID.

notes

String notes

Notes about the deposit release.

reason

String reason

Reason for the deposit release.

releaseAmount

Money releaseAmount

releaseRef

String releaseRef

The deposit release reference.

releaseType

Integer releaseType

The deposit release type.
Allowed Values: PREPAYMENT, REFUND

status

String status

The deposit release status.
Allowed Values: COMPLETED, FAILED, PENDING, ACCEPTED, REJECTED

Class com.oracle.communications.brm.cc.model.DepositReversal

class DepositReversal extends Object implements Serializable

Serialized Fields

completedAt

XMLGregorianCalendar completedAt

The deposit reversal completion date.

createdAt

XMLGregorianCalendar createdAt

The date when the deposit reversal is initiated.

customerDepositRef

String customerDepositRef

The customer deposit reference.

customerRef

String customerRef

The customer reference.

error

String error

Error message for the deposit reversal.

href

String href

The unique resource URL, used to get the object.

id

String id

The deposit reversal ID.

notes

String notes

Notes about the deposit reversal.

reason

String reason

Reason for the deposit reversal.

status

String status

The deposit reversal status.
Allowed Values: COMPLETED, FAILED, PENDING, ACCEPTED, REJECTED

Class com.oracle.communications.brm.cc.model.DepositSpec

class DepositSpec extends Object implements Serializable

Serialized Fields

amount

Money amount

billPreference

Integer billPreference

The bill preference for the deposit specification. Allowed Values:

• 0 (Immediate)
• 1 (Auto-align)

category

String category

The deposit specification category.

chargeOfferRef

String chargeOfferRef

The charge offer reference for the deposit specification.

code

String code

The deposit specification code type.

createdAt

String createdAt

The date when the deposit specification is created.

creditLimitFlag

Boolean creditLimitFlag

Specify whether to increase the customer credit limit by the deposit amount (true) or not (false).

descr

String descr

The deposit specification description.

expiresAt

String expiresAt

The expiry date of the deposit specification.

glCode

String glCode

The general ledger ID.

href

String href

The unique resource URL, used to get the object.

id

String id

The deposit specification ID.

modifiedAt

String modifiedAt

The date when the deposit specification is modified.

name

String name

The deposit specification name.

permitted

String permitted

Specify whether the deposit specification is permitted (true) or not (false).

profileRef

String profileRef

The deposit specification profile reference.

startsAt

String startsAt

The date when the deposit specification starts.

status

Integer status

The deposit specification status. Allowed Values: 0 (Active), 1 (Draft), 2 (Canceled).

Class com.oracle.communications.brm.cc.model.DepositSpecProfile

class DepositSpecProfile extends Object implements Serializable

Serialized Fields

code

String code

The deposit specification profile code.

createdAt

String createdAt

The date when the deposit specification profile is created.

descr

String descr

The deposit specification profile description.

expiresAt

String expiresAt

The expiry date of the deposit specification profile.

hostName

String hostName

Not used.

href

String href

The unique resource URL, used to get the deposit specification profile object.

id

String id

The deposit specification profile ID.

interestRule

DepositInterestRule interestRule

isExemptible

Boolean isExemptible

Specify whether the deposit specification profile is exemptible (true) or not (false).

isOverridable

Boolean isOverridable

Specify whether the deposit specification profile is overridable (true) or not (false).

isPayinterest

Boolean isPayinterest

Specify whether the interest must be paid for the deposit specification profile (true) or not (false).

isRefundable

String isRefundable

Not used.

isTransferrable

Boolean isTransferrable

Specify whether the deposit specification profile is transferrable (true) or not (false).

modifiedAt

String modifiedAt

The date when the deposit specification profile is modified.

name

String name

The deposit specification profile name.

refundRule

DepositRefundRule refundRule

releaseType

Integer releaseType

The release type for the deposit specification profile. Allowed Values: 1 (Prepayment), 2 (Refund), 3 (Zeroise).

startDateTime

String startDateTime

The start date of the deposit specification profile.

status

String status

The deposit specification profile status. Allowed Values: 0 (Active), 1 (Draft), 2 (Canceled).

validityRule

DepositValidityRule validityRule

validityRuleSource

String validityRuleSource

The deposit validity rule source.
Allowed Values: SYSTEM_DEFINED, RULE_DEFINED

Class com.oracle.communications.brm.cc.model.DepositTransfer

class DepositTransfer extends Object implements Serializable

Serialized Fields

completedAt

String completedAt

The deposit transfer completion date.

createdAt

String createdAt

The date when the deposit transfer is initiated.

customerDepositRef

String customerDepositRef

The customer deposit reference.

customerRef

String customerRef

The customer reference.

destBillProfileRef

String destBillProfileRef

The destination bill profile reference for the transfer.

destCustomerRef

String destCustomerRef

The destination customer reference for the transfer.

destServiceRef

String destServiceRef

The destination service reference for the transfer.

error

String error

Error message for the deposit transfer.

glCode

String glCode

The general ledger ID.

href

String href

The unique resource URL, used to get the object.

id

String id

The deposit transfer ID.

reason

String reason

Reason for the deposit transfer.

status

String status

The deposit transfer status.
Allowed Values: COMPLETED, FAILED, PENDING, ACCEPTED, REJECTED

transferAmount

Money transferAmount

transferRef

String transferRef

The deposit transfer reference.

Class com.oracle.communications.brm.cc.model.DepositTxn

class DepositTxn extends Object implements Serializable

Serialized Fields

balanceImpacts

List<DepositTxnBalanceImpacts> balanceImpacts

createdAt

String createdAt

The date when the deposit transaction event is created.

depositDetails

List<DepositTxnDepositDetails> depositDetails

depositInfo

List<DepositTxnDepositInfo> depositInfo

descr

String descr

The deposit transaction event description.

href

String href

The unique resource URL, used to get the deposit transaction event.

id

String id

The deposit transaction event ID.

modifiedAt

String modifiedAt

The date when the deposit transaction event is modified.

notes

List<DepositTxnNotes> notes

payment

DepositTxnPayment payment

quantity

BigDecimal quantity

The quantity of the deposit transaction event.

startsAt

String startsAt

The start date of the deposit transaction event.

systemEvent

String systemEvent

The system event of the deposit transaction event.

txnType

String txnType

The transaction type of the deposit transaction event.

Class com.oracle.communications.brm.cc.model.DepositTxnBalanceImpacts

class DepositTxnBalanceImpacts extends Object implements Serializable

Serialized Fields

amount

Money amount

discountAmount

Money discountAmount

resourceId

String resourceId

The balance impact's resource ID.

tax

Money tax

Class com.oracle.communications.brm.cc.model.DepositTxnDepositDetails

class DepositTxnDepositDetails extends Object implements Serializable

Serialized Fields

depositRef

String depositRef

The deposit reference.

destDepositRef

String destDepositRef

The destination deposit reference.

sourceDepositRef

String sourceDepositRef

The source deposit reference.

Class com.oracle.communications.brm.cc.model.DepositTxnDepositInfo

class DepositTxnDepositInfo extends Object implements Serializable

Serialized Fields

amount

Money amount

billInfoRef

String billInfoRef

The bill reference.

customerRef

String customerRef

The customer reference.

dayOfWeek

Integer dayOfWeek

The day of the week.

serviceRef

String serviceRef

The service reference.

toBillInfoRef

String toBillInfoRef

The bill reference to which the transaction is made.

toServiceRef

String toServiceRef

The service reference to which the transaction is made.

Class com.oracle.communications.brm.cc.model.DepositTxnNotes

class DepositTxnNotes extends Object implements Serializable

Serialized Fields

createdAt

String createdAt

The date when the deposit transaction note is created.

id

String id

The deposit transaction note ID.

modifiedAt

String modifiedAt

The date when the deposit transaction note is modified.

note

String note

The deposit transaction note.

Class com.oracle.communications.brm.cc.model.DepositTxnPayment

class DepositTxnPayment extends Object implements Serializable

Serialized Fields

completedAt

String completedAt

The date when the deposit payment is completed.

createdAt

String createdAt

The date when the deposit payment is created.

customerDepositRef

String customerDepositRef

The deposit reference.

customerRef

String customerRef

The customer reference.

glCode

String glCode

The general ledger code for the deposit payment.

href

String href

The unique resource URL, used to get the deposit payment.

id

String id

The deposit payment ID.

notes

String notes

The notes for the deposit payment.

payinfoTypeObject

PaymentTypeBase payinfoTypeObject

The details of the payment type. Can be one of the following:

• Externalpayment10011: Cash
• Externalpayment10012: Check
• Externalpayment10013: Wire transfer
• Externalpayment10014: Inter-bank payment order
• Externalpayment10015: Postal payment order
• Externalpayment10017: Failed payment
• Externalpayment10018: SEPA payment

paymentAmount

Money paymentAmount

paymentId

String paymentId

The payment ID for the deposit payments.

paymentMethodType

Integer paymentMethodType

The payment method type. Allowed Values:

• 10003 (Credit card)
• 10005 (Direct debit)
• 10011 (Cash)
• 10012 (Check)
• 10013 (Wire Transfer)
• 10014 (Inter-bank payment order)
• 10015 (Postal order)
• 3 (Prepayment)
• 4 (Other)

paymentRef

String paymentRef

The payment reference.

status

Integer status

The deposit payment transaction status. Allowed Values:

• 1 (Completed)
• 2 (Failed)
• 3 (Pending)

transactionId

String transactionId

Indicates the transaction ID for the deposit payments.

Class com.oracle.communications.brm.cc.model.DepositValidityRule

class DepositValidityRule extends Object implements Serializable

Serialized Fields

endOffsetPeriodUnit

Integer endOffsetPeriodUnit

The unit of measure for the end offset.
Allowed Values:

• 0 (Month)
• 1 (Day)
• 2 (Week)
• 3 (Year)

endOffsetPeriodValue

Integer endOffsetPeriodValue

The value for the end offset.

Class com.oracle.communications.brm.cc.model.DeviceNumType

class DeviceNumType extends DeviceType implements Serializable

Serialized Fields

deviceNUMDetails

DeviceNumType.DeviceNUMDetails deviceNUMDetails

Class com.oracle.communications.brm.cc.model.DeviceNumType.DeviceNUMDetails

class DeviceNUMDetails extends Object implements Serializable

Serialized Fields

categoryId

Integer categoryId

networkElement

String networkElement

vanity

Integer vanity

Class com.oracle.communications.brm.cc.model.DeviceSimType

class DeviceSimType extends DeviceType implements Serializable

Serialized Fields

deviceSIMDetails

DeviceSimType.DeviceSIMDetails deviceSIMDetails

Class com.oracle.communications.brm.cc.model.DeviceSimType.DeviceSIMDetails

class DeviceSIMDetails extends Object implements Serializable

Serialized Fields

imsi

String imsi

networkElement

String networkElement

personalId1

String personalId1

personalId2

String personalId2

personalUnblockingKey1

String personalUnblockingKey1

personalUnblockingKey2

String personalUnblockingKey2

Class com.oracle.communications.brm.cc.model.DeviceType

class DeviceType extends Extension implements Serializable

Serialized Fields

description

String description

The device type's description.

deviceId

String deviceId

The device ID.

id

ResourceRef id

Class com.oracle.communications.brm.cc.model.DirectDebitType

class DirectDebitType extends PaymentInstrumentType implements Serializable

Serialized Fields

details

DirectDebitType.Details details

The direct debit details.

Class com.oracle.communications.brm.cc.model.DirectDebitType.Details

class Details extends Object implements Serializable

Serialized Fields

accountType

int accountType

The bank account type. Possible values are:

• 1: Checking account
• 2: Savings account
• 3: Corporate account.

.

address

String address

The street address associated with the bank account.

bankNumber

String bankNumber

The RDFI or Bank ID used for routing transactions.

cardActivationDate

Calendar cardActivationDate

The date and time the card was activated.

city

String city

The city associated with the bank account.

country

String country

The country associated with the bank account.

debitNumber

String debitNumber

The RDFI or Bank ID used for routing transactions.

fiasId

String fiasId

The FIAS ID.

mandateReceivedDate

Calendar mandateReceivedDate

The date and time the mandate was received.

mandateStatus

int mandateStatus

The current mandate status.

name

String name

The name as it appears on the bank account.

state

String state

The state associated with the bank account.

zip

String zip

The ZIP code associated with the bank account.

Class com.oracle.communications.brm.cc.model.Discount

class Discount extends Extension implements Serializable

Serialized Fields

description

String description

The discount's description.

id

ResourceRef id

lastStatusChange

Calendar lastStatusChange

The date and time the discount's status was last changed.

name

String name

The discount's name.

planName

String planName

The name of the package containing the discount.

purchaseDate

Calendar purchaseDate

The date and time the discount was purchased.

purchaseEndDate

Calendar purchaseEndDate

The date and time the purchase ends.

status

String status

The discount's status

type

int type

The type of discount. Can be one of the following:

• 0: Optional
• 1: Required
• 2: Regular

Class com.oracle.communications.brm.cc.model.DiscountOfferType

class DiscountOfferType extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

code

String code

The code associated with the discount offer.

creationDate

Calendar creationDate

The date and time the discount offer was created.

description

String description

The discount offer's description.

discountOfferCycleValidity

List<DiscountOfferType.DiscountOfferCycleValidity> discountOfferCycleValidity

The discount offer's cycle validity information.

discountOfferUsageValidity

List<DiscountOfferType.DiscountOfferUsageValidity> discountOfferUsageValidity

The discount offer's usage validity information.

ends

Calendar ends

The date and time the discount offer validity ends.

lastModified

Calendar lastModified

The date and time the discount offer was last modified.

mode

String mode

The discount offer's mode.

name

String name

The discount offer's name.

ownMax

BigDecimal ownMax

The maximum number of the discount offer an account can own.

ownMin

BigDecimal ownMin

The minimum number of the discount offer an account can own.

permitted

String permitted

The purchase level permitted for the discount offer.

priority

BigDecimal priority

The discount offer's priority.

provisioningTag

String provisioningTag

The discount offer's provisioning tag.

purchaseMax

BigDecimal purchaseMax

The maximum number of the discount offer an account can purchase.

purchaseMin

BigDecimal purchaseMin

The minimum number of the discount offer an account can purchase.

resourceRef

ResourceRef resourceRef

starts

Calendar starts

The date and time the discount offer validity starts.

type

String type

The discount offer's type.

usageMap

List<DiscountOfferType.UsageMap> usageMap

The usage map associated with the discount offer.

Class com.oracle.communications.brm.cc.model.DiscountOfferType.DiscountOfferCycleValidity

class DiscountOfferCycleValidity extends Object implements Serializable

Serialized Fields

discountOfferFlags

String discountOfferFlags

The discount offer cycle validity flags.

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

Class com.oracle.communications.brm.cc.model.DiscountOfferType.DiscountOfferUsageValidity

class DiscountOfferUsageValidity extends Object implements Serializable

Serialized Fields

discountOfferFlags

String discountOfferFlags

The discount offer's usage validity flags.

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

Class com.oracle.communications.brm.cc.model.DiscountOfferType.UsageMap

class UsageMap extends Object implements Serializable

Serialized Fields

discount

String discount

The discount.

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

eventType

String eventType

The event type.

flags

Integer flags

The flags.

modelSelector

String modelSelector

The model selector.

snowballFlag

Integer snowballFlag

The snowball flag.

Class com.oracle.communications.brm.cc.model.DisputeBill

class DisputeBill extends ARActionRequestType implements Serializable

Class com.oracle.communications.brm.cc.model.DisputeEvent

class DisputeEvent extends EventARAction implements Serializable

Class com.oracle.communications.brm.cc.model.DisputeItem

class DisputeItem extends ARActionRequestType implements Serializable

Class com.oracle.communications.brm.cc.model.EditAction

class EditAction extends Extension implements Serializable

Serialized Fields

actionFlag

Integer actionFlag

Which collections action to reschedule. Can be one of the following:

• 0: Only the selected action.
• 1: All pending errored actions.
• 2: Do not reschedule actions.

amount

BigDecimal amount

The amount due to be collected.

cancelFollowupActions

boolean cancelFollowupActions

Whether to cancel all follow-up actions (true) or keep the existing follow-up actions (false).

notes

Notes notes

rescheduleAction

boolean rescheduleAction

Whether to reschedule the collections action (true) or not (false).

rescheduleDate

Calendar rescheduleDate

The date and time to reschedule the collections action to. If rescheduleAction is set to false, specify an empty string here.

slipByDays

Integer slipByDays

The number of days to slip the schedule.

status

int status

The collection action's status. Can be one of the following:

• 0: Pending
• 1: Canceled
• 2: Completed
• 3: Error

Class com.oracle.communications.brm.cc.model.EndingType

class EndingType extends Object implements Serializable

Serialized Fields

endDate

Calendar endDate

The date and time the cycle ends.

mode

String mode

The ending type mode for a product. Can be one of the following:

• absolute: The end date is a calendar day.
• relativeToStart: The end date is relative to the start date, such as a specified number of billing cycles, months, days, hours, minutes, or seconds after the start date.
• never: There is no set end date.

unitSettings

RelativeSettings unitSettings

Class com.oracle.communications.brm.cc.model.EntityRef

class EntityRef extends Object implements Serializable

Serialized Fields

href

String href

id

String id

Class com.oracle.communications.brm.cc.model.ErrorInfo

class ErrorInfo extends Extension implements Serializable

Serialized Fields

errorCode

Long errorCode

errorMessage

String errorMessage

isValidationError

Boolean isValidationError

paramInfo

List<ParamInfo> paramInfo

Class com.oracle.communications.brm.cc.model.Event

class Event extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

Event's account holder.

archiveStatus

int archiveStatus

Archiving status for this event instance.

balanceImpacts

List<BalanceImpact> balanceImpacts

The detailed breakdown of the balance impact.

batchId

String batchId

Batch Id this event belongs to.

created

Calendar created

The time when event object was created.

currency

int currency

Currency of the account to which this event applies to.

earnedEndTime

Calendar earnedEndTime

The time when event stops earning.

earnedStartTime

Calendar earnedStartTime

The time when event starts earning.

earnedType

Integer earnedType

Indicator for earnings type. Value of zero (default) indicates that the event is earned immediately. Value of 1 indicate that the event is earned over a period of time.

effectiveT

Calendar effectiveT

Effective time of the event.

endTime

Calendar endTime

The time when event ends.

eventCategory

String eventCategory

This name is used as the identifier for the event tab in UI.

eventDesc

String eventDesc

The event description.

eventNumber

String eventNumber

User-definable field for assigning event numbers.

flags

int flags

Reserved for future use.

groupRef

ResourceRef groupRef

Link to the group object to which this event object is related to.

id

ResourceRef id

The event object's id.

incrQuantity

double incrQuantity

Incremental value to round RUM Quantity to. RUM Quantity is always rounded to an integral multiple of the Incr Quantity.

incrUnit

double incrUnit

Units that incrQuantity is specified in.

invoiceData

String invoiceData

Cache the fields in /event that need to be handled in invoicing. This is to improve the performance in event search by moving some sub-table fields into this top level field.

itemRef

ResourceRef itemRef

Associated item.

linkObj

ResourceRef linkObj

The poid of the previous event.

loaderBatchRef

ResourceRef loaderBatchRef

The poid of the session which inserted this event.

minQuantity

double minQuantity

Minimum value that the RUM quantity is rounded to. Value smaller than min_quantity is rounded to min_quantity.

minUnit

int minUnit

Unit min_quantity is expressed in. Value can be NONE(0), SECOND(1), MINUTE(2), HOUR(3) or DAY(4).

modT

Calendar modT

The time in epoch when this event was last modified.

monitorImpacts

List<MonitorImpact> monitorImpacts

Detail breakdown of monitor impacts.

monitorSubBalanceImpacts

List<SubBalanceImpact> monitorSubBalanceImpacts

Array to hold the sub_balances impacts for a particular monitor balance group and its resource.

name

String name

The name of the event.

napIdAddress

String napIdAddress

This field contains the IP Address of the client machine.

netQuantity

double netQuantity

Net quantity calculated after performing the rounding.

networkSessionId

String networkSessionId

Field used by the system to record the session identifier for the event.

originalBatchId

String originalBatchId

Mediation Batch Id this event belongs to.

profileLabelList

String profileLabelList

This field contains list of ERA labels.

providerDescr

String providerDescr

When a part of the charges associated with this event needs to be remitted to another vendor, this field identifies the topic to which it relates to.

providerIpaddr

String providerIpaddr

IP address of the service provider.

providerRef

ResourceRef providerRef

When a part of the charges associated with this event needs to be remitted to another vendor, this field provides a link to the service provider object that represents the provider account.

ratedTimezoneId

String ratedTimezoneId

TimeZone ID actually used for rating.

rerateRef

ResourceRef rerateRef

Link to the event object if this event is re-rated NULL implies no re-rating. This field is overloaded in that a type-only poid means this event is a shadow event created for transfering sponsoree charges from one /item/sponsor to another.

roundingMode

int roundingMode

Specifies how RUM quantity is rounded.

rumMap

List<RumMap> rumMap

This array will hold the information for the rums that have been used to rate the event. It is optional. The RUM_ID in the balance impacts array refers to the element id in this array.

rumName

String rumName

Specifies which RUM was used to rate this event type. Must be a defined Candidate RUM for this event type.

serviceRef

ResourceRef serviceRef

Associated service.

sessionRef

ResourceRef sessionRef

Link to the event object (/event/session) that represents the session within which this event occurred.

startTime

Calendar startTime

The time when the event started.

subBalanceImpacts

List<SubBalanceImpact> subBalanceImpacts

Array to hold the sub_balances impacts.

sysDescr

String sysDescr

System generated description - describes event programmatically. The actual value depends on the various event subtypes.

taxJurisdictions

List<TaxJurisdiction> taxJurisdictions

Array of tax details. Array element id is not significant. Each array element corresponds to a jurisdiction pair. If multiple rates were applicable in determining the event balance impacts, then it is possible to have many rows for the same jurisdiction.

taxLocales

String taxLocales

Tax locales -- order origin;order accept;ship from;ship to. If the location of the company is available, it is appended to the above string. If a telephony event, then NPA/NXX or Geocode information is appended to the above string.

taxSupplier

int taxSupplier

The event's tax supplier.

timezoneAdjEndTime

Calendar timezoneAdjEndTime

This timestamp is same as created time value.

timezoneAdjStartTime

Calendar timezoneAdjStartTime

This timestamp is same as created time value.

timezoneId

String timezoneId

TimeZone ID of the event as String.

timezoneMode

int timezoneMode

Timezone mode defines which timezone to use when apply TOD rates.

todMode

int todMode

TOD mode defines how TOD rates are applied to the event.

unit

int unit

Unit of the quantity applied.

unratedQuantity

double unratedQuantity

Quantity which has not been rated.

usageType

String usageType

Type describes the specific customer related call scenario. E.g. Customer-to-customer call, birthdate call, closed-user-group calls, friends and family, etc.

userRef

ResourceRef userRef

The unique ID of the user who is running program that started the event.

Class com.oracle.communications.brm.cc.model.EventARAction

class EventARAction extends AdjustmentBillType implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

appliesToTotalOfAllEvents

boolean appliesToTotalOfAllEvents

Whether the adjustment applies to the total from all events (true) or not (false).

events

EventARAction.Events events

The events.

taxType

int taxType

Whether to include tax in the adjustment (8), exclude the tax and adjust only the amount (9), or adjust only the tax (10).

Class com.oracle.communications.brm.cc.model.EventARAction.Events

class Events extends Object implements Serializable

Serialized Fields

eventRef

List<ResourceRef> eventRef

Class com.oracle.communications.brm.cc.model.EventImpactType

class EventImpactType extends Extension implements Serializable

Serialized Fields

amount

double amount

The impact to the event.

eventRef

ResourceRef eventRef

Reference of the impacted event.

Class com.oracle.communications.brm.cc.model.EventSubBalances

class EventSubBalances extends Extension implements Serializable

Serialized Fields

amount

BigDecimal amount

The amount of the sub-balance.

contributorStr

String contributorStr

The contributor for this sub-balance counter.

elementId

Integer elementId

The ID of the element.

grantedBal

BigDecimal grantedBal

The granted balance of the sub-balance.

grantorObj

ResourceRef grantorObj

The grantor object of the sub-balance.

rolloverData

Integer rolloverData

Indicates whether the leftover balance in this bucket will be rolled over, and if so, how.

subType

Integer subType

This field represents the type of sub balance.

validFrom

Calendar validFrom

The date and time the validity period starts.

validFromDetails

Integer validFromDetails

Detail of field validFrom mode.

validTo

Calendar validTo

The date and time the validity period ends.

validToDetails

Integer validToDetails

Detail of field validTo mode.

Class com.oracle.communications.brm.cc.model.ExistingBillUnits

class ExistingBillUnits extends Object implements Serializable

Serialized Fields

balanceGroups

List<BalanceGroup> balanceGroups

billUnitId

String billUnitId

The ID of the bill unit.

forServiceGroup

List<ServiceGroupIndex> forServiceGroup

Class com.oracle.communications.brm.cc.model.Extension

class Extension extends Object implements Serializable

Serialized Fields

extension

Object extension

The extended attributes.

Class com.oracle.communications.brm.cc.model.Externalpayment10011

class Externalpayment10011 extends Externalpayment10011Type implements Serializable

Class com.oracle.communications.brm.cc.model.Externalpayment10011Type

class Externalpayment10011Type extends ExternalPaymentType implements Serializable

Serialized Fields

cashInfo

List<Externalpayment10011Type.CashInfo> cashInfo

Information about a cash payment.

Class com.oracle.communications.brm.cc.model.Externalpayment10011Type.CashInfo

class CashInfo extends Object implements Serializable

Serialized Fields

billNo

String billNo

The bill number associated with the cash payment.

effectiveDate

Calendar effectiveDate

The date of the cash payment.

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

receiptNo

String receiptNo

The receipt number for the cash payment.

Class com.oracle.communications.brm.cc.model.Externalpayment10012

class Externalpayment10012 extends Externalpayment10012Type implements Serializable

Class com.oracle.communications.brm.cc.model.Externalpayment10012Type

class Externalpayment10012Type extends ExternalPaymentType implements Serializable

Serialized Fields

checkInfo

List<Externalpayment10012Type.CheckInfo> checkInfo

Information about a check payment.

Class com.oracle.communications.brm.cc.model.Externalpayment10012Type.CheckInfo

class CheckInfo extends Object implements Serializable

Serialized Fields

bankAccountNo

String bankAccountNo

The customer's bank account number.

bankCode

String bankCode

The unique identification code for the bank.

billNo

String billNo

The bill number associated with the payment.

checkNo

String checkNo

The check number.

effectiveDate

Calendar effectiveDate

The date of the check payment.

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

Class com.oracle.communications.brm.cc.model.Externalpayment10013

class Externalpayment10013 extends Externalpayment10013Type implements Serializable

Class com.oracle.communications.brm.cc.model.Externalpayment10013Type

class Externalpayment10013Type extends ExternalPaymentType implements Serializable

Serialized Fields

wireTransferInfo

List<Externalpayment10013Type.WireTransferInfo> wireTransferInfo

Information about a wire transfer payment.

Class com.oracle.communications.brm.cc.model.Externalpayment10013Type.WireTransferInfo

class WireTransferInfo extends Object implements Serializable

Serialized Fields

bankAccountNo

String bankAccountNo

The customer's bank account number.

bankCode

String bankCode

The unique identification code for the bank.

effectiveDate

Calendar effectiveDate

The date of the wire transfer payment.

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

wireTransferId

String wireTransferId

The wire transfer ID.

Class com.oracle.communications.brm.cc.model.Externalpayment10014

class Externalpayment10014 extends Externalpayment10014Type implements Serializable

Class com.oracle.communications.brm.cc.model.Externalpayment10014Type

class Externalpayment10014Type extends ExternalPaymentType implements Serializable

Serialized Fields

payOrderInfo

List<Externalpayment10014Type.PayOrderInfo> payOrderInfo

Information about a payment order.

Class com.oracle.communications.brm.cc.model.Externalpayment10014Type.PayOrderInfo

class PayOrderInfo extends Object implements Serializable

Serialized Fields

bankAccountNo

String bankAccountNo

The customer's bank account number.

bankCode

String bankCode

The unique identification code for the bank.

effectiveDate

Calendar effectiveDate

The date of the payment order.

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

orderId

String orderId

The payment order's ID.

Class com.oracle.communications.brm.cc.model.Externalpayment10015

class Externalpayment10015 extends Externalpayment10015Type implements Serializable

Class com.oracle.communications.brm.cc.model.Externalpayment10015Type

class Externalpayment10015Type extends ExternalPaymentType implements Serializable

Serialized Fields

postalOrderInfo

List<Externalpayment10015Type.PostalOrderInfo> postalOrderInfo

Information about a postal order.

Class com.oracle.communications.brm.cc.model.Externalpayment10015Type.PostalOrderInfo

class PostalOrderInfo extends Object implements Serializable

Serialized Fields

effectiveDate

Calendar effectiveDate

The date of the postal order.

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

orderId

String orderId

The postal order's ID.

Class com.oracle.communications.brm.cc.model.Externalpayment10017

class Externalpayment10017 extends Externalpayment10017Type implements Serializable

Class com.oracle.communications.brm.cc.model.Externalpayment10017Type

class Externalpayment10017Type extends ExternalPaymentType implements Serializable

Serialized Fields

paymentFailedInfo

List<Externalpayment10017Type.PaymentFailedInfo> paymentFailedInfo

Information about a failed payment.

Class com.oracle.communications.brm.cc.model.Externalpayment10017Type.PaymentFailedInfo

class PaymentFailedInfo extends Object implements Serializable

Serialized Fields

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

paymentTransId

String paymentTransId

The transaction ID associated with the failed payment.

Class com.oracle.communications.brm.cc.model.Externalpayment10018

class Externalpayment10018 extends Externalpayment10018Type implements Serializable

Class com.oracle.communications.brm.cc.model.Externalpayment10018Type

class Externalpayment10018Type extends ExternalPaymentType implements Serializable

Serialized Fields

sepaInfo

List<Externalpayment10018Type.SepaInfo> sepaInfo

Information about a SEPA payment.

Class com.oracle.communications.brm.cc.model.Externalpayment10018Type.SepaInfo

class SepaInfo extends Object implements Serializable

Serialized Fields

bic

String bic

The Bank Identifier Code (BIC).

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

iban

String iban

The International Bank Account Number (IBAN).

mandateType

Integer mandateType

The type of SEPA mandate.

mandateUniqueReference

String mandateUniqueReference

The unique mandate reference information.

Class com.oracle.communications.brm.cc.model.ExternalPaymentMetaData

class ExternalPaymentMetaData extends Object implements Serializable

Serialized Fields

classType

String classType

fields

List<Fields> fields

internalStruct

String internalStruct

type

String type

Class com.oracle.communications.brm.cc.model.ExternalPaymentType

class ExternalPaymentType extends PaymentTypeBase implements Serializable

Serialized Fields

externalType

boolean externalType

Whether this is an externally initiated payment such as cash or check (true) or a BRM-initiated payment such as for a credit card (false).

Class com.oracle.communications.brm.cc.model.FieldData

class FieldData extends Object implements Serializable

Serialized Fields

custom

boolean custom

fieldType

String fieldType

name

String name

path

String path

Class com.oracle.communications.brm.cc.model.Fields

class Fields extends Object implements Serializable

Serialized Fields

datatype

String datatype

fieldName

String fieldName

label

String label

Class com.oracle.communications.brm.cc.model.FieldsFromStorableClass

class FieldsFromStorableClass extends Object implements Serializable

Serialized Fields

fieldData

List<FieldData> fieldData

group

String group

Class com.oracle.communications.brm.cc.model.FullRefund

class FullRefund extends Extension implements Serializable

Serialized Fields

notes

Notes notes

payinfoTypeObject

PaymentTypeBase payinfoTypeObject

Class com.oracle.communications.brm.cc.model.GenericTemplate

class GenericTemplate extends Extension implements Serializable

Serialized Fields

columnHeader

List<GenericTemplate.ColumnHeader> columnHeader

filter

GenericTemplate.Filter filter

referencedTemplates

GenericTemplate.ReferencedTemplates referencedTemplates

saveResults

Boolean saveResults

sortbyFields

List<GenericTemplate.SortbyFields> sortbyFields

storableClass

GenericTemplate.StorableClass storableClass

Class com.oracle.communications.brm.cc.model.GenericTemplate.ColumnHeader

class ColumnHeader extends Object implements Serializable

Serialized Fields

alignment

String alignment

label

String label

name

String name

resizable

Boolean resizable

sortable

Boolean sortable

tooltip

String tooltip

visible

Boolean visible

width

String width

Class com.oracle.communications.brm.cc.model.GenericTemplate.Filter

class Filter extends Extension implements Serializable

Serialized Fields

criteria

List<Criteria> criteria

defaultPageSize

Integer defaultPageSize

Class com.oracle.communications.brm.cc.model.GenericTemplate.ReferencedTemplates

class ReferencedTemplates extends Object implements Serializable

Serialized Fields

template

List<GenericTemplate.ReferencedTemplates.Template> template

Class com.oracle.communications.brm.cc.model.GenericTemplate.ReferencedTemplates.Template

class Template extends Object implements Serializable

Serialized Fields

appearanceOrder

Integer appearanceOrder

id

String id

name

String name

Class com.oracle.communications.brm.cc.model.GenericTemplate.SortbyFields

class SortbyFields extends Object implements Serializable

Serialized Fields

defaultSort

Boolean defaultSort

field

String field

name

String name

sortingPriority

Integer sortingPriority

sortOrder

String sortOrder

Class com.oracle.communications.brm.cc.model.GenericTemplate.StorableClass

class StorableClass extends Object implements Serializable

Serialized Fields

column

List<GenericTemplate.StorableClass.Column> column

name

String name

Class com.oracle.communications.brm.cc.model.GenericTemplate.StorableClass.Column

class Column extends Object implements Serializable

Serialized Fields

fields

List<String> fields

format

List<String> format

formula

String formula

name

String name

refFieldId

String refFieldId

styles

List<String> styles

type

String type

types

List<String> types

Class com.oracle.communications.brm.cc.model.GLIDSpec

class GLIDSpec extends Object implements Serializable

Serialized Fields

descr

String descr

The general ledger label or name.

glid

String glid

The general ledger ID.

Class com.oracle.communications.brm.cc.model.GroupOfServices

class GroupOfServices extends Object implements Serializable

Serialized Fields

groupIndex

Integer groupIndex

The group index.

service

List<ServiceInPlan> service

Class com.oracle.communications.brm.cc.model.HolderOfPaymentMethods

class HolderOfPaymentMethods extends Extension implements Serializable

Serialized Fields

id

String id

The ID.

singlePaymentType

PaymentTypeBase singlePaymentType

wallet

List<PaymentTypeBase> wallet

Class com.oracle.communications.brm.cc.model.InsertAction

class InsertAction extends Extension implements Serializable

Serialized Fields

amount

BigDecimal amount

The amount to collect for the new action.

billUnitRef

ResourceRef billUnitRef

cancelFollowupActions

boolean cancelFollowupActions

Whether to cancel all of the follow-up collections actions (true) or keep the existing follow-up collections actions (false).

collectionAgent

String collectionAgent

The agent assigned to the collections action.

notes

Notes notes

paymentMethodRef

ResourceRef paymentMethodRef

slipByDays

Integer slipByDays

The number of days to slip the scheduled action.

startDate

Calendar startDate

The date and time the collections action starts.

Class com.oracle.communications.brm.cc.model.Installment

class Installment extends Object implements Serializable

Serialized Fields

amount

Money amount

createdAt

String createdAt

The date of creation.

customerRef

String customerRef

The customer reference.

descr

String descr

The installment description.

dueDate

String dueDate

The date of installment collection/charge.

href

String href

The unique resource URL, used for getting the object.

id

String id

The installment's ID.

scheduleRef

String scheduleRef

The reference to the installment schedule.

status

Integer status

The installment status. Allowed Values:

• 100 (Open)
• 101 (Charged)
• 102 (Paid)
• 103 (Broken)
• 104 (Canceled)
• 105 (Finished)

Class com.oracle.communications.brm.cc.model.InstallmentBill

class InstallmentBill extends Object implements Serializable

Serialized Fields

billItems

List<InstallmentBillItem> billItems

billNo

String billNo

The installment bill number.

dueAmount

Money dueAmount

dueAt

String dueAt

When the installment bill is due.

id

String id

The installment bill ID.

Class com.oracle.communications.brm.cc.model.InstallmentBillInfo

class InstallmentBillInfo extends Object implements Serializable

Serialized Fields

bills

List<InstallmentBill> bills

customerRef

String customerRef

The customer reference.

id

String id

The installment bill ID.

Class com.oracle.communications.brm.cc.model.InstallmentBillItem

class InstallmentBillItem extends Object implements Serializable

Serialized Fields

billItemNumber

String billItemNumber

The installment bill item number.

billRef

String billRef

The bill reference.

createdAt

String createdAt

The date and time the installment bill item was created.

customerRef

String customerRef

The customer reference.

dueAmount

Money dueAmount

id

String id

The installment bill item ID.

Class com.oracle.communications.brm.cc.model.InstallmentChargeOffer

class InstallmentChargeOffer extends Object implements Serializable

Serialized Fields

code

String code

The code for the charge offer.

createdAt

String createdAt

The date the charge offer was created.

descr

String descr

The description of the charge offer.

expiresAt

String expiresAt

The date the charge offer expires.

id

String id

The ID of the charge offer.

name

String name

The name of the charge offer.

offerType

Integer offerType

The ID of the charge offer type.

permitted

String permitted

The purchase level permitted for the charge offer.

startsAt

String startsAt

The date the charge offer starts.

Class com.oracle.communications.brm.cc.model.InstallmentProposal

class InstallmentProposal extends Object implements Serializable

Serialized Fields

bills

List<InstallmentScheduleBills> bills

customerRef

String customerRef

The customer reference.

href

String href

The unique resource URL, used for getting the object.

id

String id

The installment proposal's ID. Proposals are not persisted in the system, so this field is always null.

installmentPeriod

String installmentPeriod

The installment cycle. For future use. Allowed Values: ANNUAL, SEMI-ANNUAL, QUARTERLY, MONTHLY, WEEKLY, DAILY. Default Value: MONTHLY

installmentType

String installmentType

The installment type. Allowed Values: EQUAL INSTALLMENT, NON-EQUAL INSTALLMENT

specRef

String specRef

The installment schedule specification reference.

totalAmount

Money totalAmount

totalInstallments

Integer totalInstallments

The total number of installments.

validFor

TimePeriod validFor

Class com.oracle.communications.brm.cc.model.InstallmentSchedule

class InstallmentSchedule extends Object implements Serializable

Serialized Fields

billPreference

Integer billPreference

Indicates either to bill the installment amount immediately or to keep it open and include it with the customer's billing cycle. Allowed Values:

• 0 (Auto-align)
• 1 (Immediate)

billProfileRef

String billProfileRef

The customer bill unit reference.

bills

List<InstallmentScheduleBills> bills

channel

String channel

The source of the request, for example the name of the store or app. For future use.

chargeOfferRef

String chargeOfferRef

The charge offer reference. For future use.

code

String code

Placeholder for the external code.

createdAt

String createdAt

The date of creation.

customerRef

String customerRef

The customer account reference.

descr

String descr

The installment schedule description.

expiresAt

String expiresAt

The expiration date.

glid

String glid

The general ledger ID for the installment charge.

href

String href

The unique resource URL, used for getting the object.

id

String id

The installment schedule's ID.

installmentAmount

Money installmentAmount

installmentPeriod

String installmentPeriod

The installment cycle. For future use. Allowed Values: ANNUAL, SEMI-ANNUAL, QUARTERLY, MONTHLY, WEEKLY, DAILY. Default Value: MONTHLY

installments

List<Installment> installments

installmentType

String installmentType

The installment type. Allowed Values: EQUAL INSTALLMENT, NON-EQUAL INSTALLMENT

lastInstallmentAt

String lastInstallmentAt

The last installment date. For future use.

modifiedAt

String modifiedAt

The last updated date.

name

String name

The installment schedule name.

nextInstallmentAt

String nextInstallmentAt

The next installment date. For future use.

scheduleSpecRef

String scheduleSpecRef

The installment schedule specification reference.

serviceRef

String serviceRef

The service reference.

startsAt

String startsAt

The start date.

status

Integer status

The installment schedule status. Allowed Values:

• 100 (Open)
• 101 (Charged)
• 102 (Paid)
• 103 (Broken)
• 104 (Canceled)
• 105 (Finished)

totalAmount

Money totalAmount

totalDue

Money totalDue

totalInstallments

Integer totalInstallments

The total number of installments.

validFor

TimePeriod validFor

Class com.oracle.communications.brm.cc.model.InstallmentScheduleBill

class InstallmentScheduleBill extends Object implements Serializable

Serialized Fields

billNo

String billNo

The installment schedule bill number.

createdAt

String createdAt

The date and time the installment schedule bill was created.

dueAmount

Money dueAmount

dueAt

String dueAt

The date and time the installment schedule bill is due.

id

String id

The installment schedule bill ID.

status

String status

The installment schedule bill status.

totalAmount

Money totalAmount

Class com.oracle.communications.brm.cc.model.InstallmentScheduleBillDetails

class InstallmentScheduleBillDetails extends Object implements Serializable

Serialized Fields

billDetails

List<InstallmentScheduleBill> billDetails

billInfoID

String billInfoID

The installment schedule bill information ID.

href

String href

The unique resource URL, used for getting the object.

id

String id

The installment schedule bill ID.

Class com.oracle.communications.brm.cc.model.InstallmentScheduleBills

class InstallmentScheduleBills extends Object implements Serializable

Serialized Fields

billId

String billId

The installment schedule bill ID.

Class com.oracle.communications.brm.cc.model.InstallmentScheduleSpec

class InstallmentScheduleSpec extends Object implements Serializable

Serialized Fields

createdAt

String createdAt

The date when the installment schedule specification is created.

descr

String descr

The installment schedule specification description.

expiresAt

String expiresAt

The date when the installment schedule specification expires.

glid

Integer glid

The general ledger ID used for recording the installment charge.

href

String href

The unique resource URL, used to get the object.

id

String id

The installment schedule specification ID.

maxIntervalDaysNEI

Integer maxIntervalDaysNEI

The maximum number of days between non-equal installments.

maxNumNEI

Integer maxNumNEI

The maximum number of non-equal installments.

minAmount

BigDecimal minAmount

The minimum bill/charge amount to be considered for the installment conversion. Either the minimum percentage or the minimum amount must be included.

minPercent

BigDecimal minPercent

The minimum bill/charge percentage to be considered for the installment conversion. Either the minimum percentage or the minimum amount must be included.

modifiedAt

String modifiedAt

The date when the installment schedule specification is modified.

name

String name

The installment schedule specification name.

qualifiers

List<Qualifier> qualifiers

startsAt

String startsAt

The date when the installment schedule specification starts.

Class com.oracle.communications.brm.cc.model.InvoiceType

class InvoiceType extends PaymentInstrumentType implements Serializable

Serialized Fields

details

InvoiceType.Details details

The invoice type details.

Class com.oracle.communications.brm.cc.model.InvoiceType.Details

class Details extends Object implements Serializable

Serialized Fields

address

String address

The customer's address.

city

String city

The customer's city.

country

String country

The customer's country.

deliveryPrefer

String deliveryPrefer

The customer's invoice delivery preference. Can be one of the following:

• 0: Email
• 1: Postal
• 2: Fax

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

emailAddr

String emailAddr

The customer's email address.

invoiceId

String invoiceId

The invoice's ID.

name

String name

The customer's name.

state

String state

The customer's state.

zip

String zip

The customer's ZIP code.

Class com.oracle.communications.brm.cc.model.LifeCycleStates

class LifeCycleStates extends Extension implements Serializable

Serialized Fields

servicesWithLifecycleStates

List<String> servicesWithLifecycleStates

The list of services associated with lifecycle states.

states

List<State> states

Class com.oracle.communications.brm.cc.model.LimitType

class LimitType extends Object implements Serializable

Serialized Fields

consumptionRule

Integer consumptionRule

The consumption rule. Can be one of the following:

• 0: Not defined
• 1: Earliest start time
• 2: Latest start time
• 3: Earliest expiration time
• 4: Latest expiration time
• 5: Earliest start time and latest expiration time
• 6: Earliest start time and earliest expiration time
• 7: Latest start time and earliest expiration time
• 8: Latest start time and latest expiration time
• 9: Earliest expiration time and earliest start time
• 10: Earliest expiration time and latest start time
• 10: Latest expiration time and earliest start time
• 10: Latest expiration time and latest start time

creditFloor

BigDecimal creditFloor

The credit floor amount. The credit floor is the amount that indicates none of the balance has been used. For example, if an account is granted 200 minutes, the credit floor would be -200. For currency balances, the credit floor is usually 0.

creditLimit

BigDecimal creditLimit

The credit limit amount. A credit limit specifies the maximum amount of a balance that your customers can spend. For currency balances, the credit limit is the maximum balance of euros, dollars, or so on that can accumulate in an account. For noncurrency balances, the credit limit is the amount at which an account has used all of its minutes, gigabytes, or so on, which is usually 0.

creditThresholds

Integer creditThresholds

The percent threshold for notifications. The account is sent a notification when this percent of the balance is used. The percentage must be a 5% increment. Use the decimal notation of the binary number for the bit position.

For example, to notify the account when 90% of the free minutes have been used, you calculate 90/5=18, so use the 18th bit position, which is 131072 in decimal notation. To notify when 95% have been used, use the 19th bit position, which is 262144 in decimal notation.

creditThresholdsFixed

String creditThresholdsFixed

The fixed threshold for notifications. The account is sent a notification when this fixed value of the balance is reached. You can set multiple values by using the | delimiter. For example, to notify the account when 30 minutes of usage remains and again when 5 minutes of usage remains, use |30.00|5.00

dynamicCreditFloor

Boolean dynamicCreditFloor

Whether to use a dynamic credit floor (true) or not (false). The default is false.

loanThresholds

Integer loanThresholds

loanThresholdsFixed

String loanThresholdsFixed

resourceId

Integer resourceId

The resource ID.

Class com.oracle.communications.brm.cc.model.LoanDetail

class LoanDetail extends Extension implements Serializable

Serialized Fields

availableLoanLimit

BigDecimal availableLoanLimit

The amount that the customer can currently be loaned, based on the amount specified in creditLimit and the current total outstanding amount for all active loans.

creditLimit

BigDecimal creditLimit

The maximum total amount the customer can be loaned.

loanDetails

List<LoanDetails> loanDetails

Class com.oracle.communications.brm.cc.model.LoanDetails

class LoanDetails extends Object implements Serializable

Serialized Fields

channel

String channel

The channel that requested the loan. For example, USSD or IVR.

loanAmount

BigDecimal loanAmount

The loan amount.

loanDebitRef

ResourceRef loanDebitRef

loanFee

BigDecimal loanFee

The loan's fee.

loanFeeRef

ResourceRef loanFeeRef

outstandingAmount

BigDecimal outstandingAmount

The amount of the loan that is still owed.

serviceRef

ResourceRef serviceRef

tax

BigDecimal tax

The tax to apply on the loan.

type

Integer type

The type of loan. Can be one of the following:

• 0: Currency or emergency loan
• 1: Data loan
• 2: Hybrid loan

Class com.oracle.communications.brm.cc.model.LoanProfileDetails

class LoanProfileDetails extends Object implements Serializable

Serialized Fields

id

String id

The loan profile's ID.

loanInfo

LoanProfileDetails.LoanInfo loanInfo

The loan information.

locations

List<Location> locations

name

String name

The loan profile's name.

Class com.oracle.communications.brm.cc.model.LoanProfileDetails.LoanInfo

class LoanInfo extends Object implements Serializable

Serialized Fields

age

int age

The minimum number of days, months, or years the account must be active to be eligible for a loan.

ageOffsetUnit

String ageOffsetUnit

The unit (days, months, or years) for the account age eligibility number.

loanTaxCode

String loanTaxCode

The tax code for the loan.

locationMode

Integer locationMode

Whether the locations specified are where the loan is allowed (0) or not (1).

maximum

BigDecimal maximum

The fixed maximum amount for the loan. If you specify this, you cannot specify scaledMaximum.

maxQuantity

int maxQuantity

The maximum number of times the loan can be granted in each loan cycle.

minimum

BigDecimal minimum

The minimum amount for the loan.

percentFee

BigDecimal percentFee

The percent of the loan to charge as a service fee. If you specify this, you cannot specify serviceFee.

reasonDomainId

int reasonDomainId

The A/R reason domain to map to the G/L ID.

reasonId

int reasonId

The A/R reason code to map to the G/L ID.

resourceId

int resourceId

The ID of a noncurrency resource to use when calculating the loan when scaledMaximum is specified.

scaledMaximum

BigDecimal scaledMaximum

The maximum scaled amount to grant. This is a percent of the resource specified in resourceId, which represents consumption of a noncurrency resource in the previous calendar month. If you specify this, you cannot specify the maximum element.

serviceFee

BigDecimal serviceFee

The fixed amount to charge as service fee. If you specify this, you cannot specify percentFee.

taxCode

String taxCode

The tax code for the loan service fee.

Class com.oracle.communications.brm.cc.model.Location

class Location extends Object implements Serializable

Serialized Fields

location

String location

A location where the loan is allowed or not, depending on the value of locationMode.

Class com.oracle.communications.brm.cc.model.LocationDetails

class LocationDetails extends Object implements Serializable

Serialized Fields

locale

String locale

A locale.

zoneMapName

String zoneMapName

The zone map's name.

zoneMapTarget

String zoneMapTarget

The target zone map.

Class com.oracle.communications.brm.cc.model.Mapping

class Mapping extends Object implements Serializable

Serialized Fields

brmName

String brmName

uiName

String uiName

Class com.oracle.communications.brm.cc.model.MenuDefinition

class MenuDefinition extends Object implements Serializable

Serialized Fields

menu

List<MenuDefinition.Menu> menu

Class com.oracle.communications.brm.cc.model.MenuDefinition.Menu

class Menu extends Object implements Serializable

Serialized Fields

contents

MenuDefinition.Menu.Contents contents

headerKey

String headerKey

id

String id

Class com.oracle.communications.brm.cc.model.MenuDefinition.Menu.Contents

class Contents extends Object implements Serializable

Serialized Fields

item

List<MenuDefinition.Menu.Contents.Item> item

Class com.oracle.communications.brm.cc.model.MenuDefinition.Menu.Contents.Item

class Item extends Object implements Serializable

Serialized Fields

actionKey

String actionKey

descriptionKey

String descriptionKey

id

String id

labelKey

String labelKey

permissionKey

String permissionKey

separator

Boolean separator

version

String version

Class com.oracle.communications.brm.cc.model.Money

class Money extends Object implements Serializable

Serialized Fields

amount

BigDecimal amount

The amount of money.

currency

Integer currency

The currency for the money.

Class com.oracle.communications.brm.cc.model.MonitorImpact

class MonitorImpact extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

Link to the account object whose balance is impacted as specified.

amount

double amount

The impact to the account balance.

balanceGroupRef

ResourceRef balanceGroupRef

The Monitor balance group object these sub balance impact belongs to.

resourceId

int resourceId

Numeric value of the resource that is impacted.

Class com.oracle.communications.brm.cc.model.NewBillUnit

class NewBillUnit extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

balanceGroups

List<NewBillUnit.BalanceGroups> balanceGroups

The list of balance groups associated with the new bill unit.

id

String id

The ID.

name

String name

The name of the new bill unit.

paymentType

String paymentType

The payment type of the new bill unit.

Class com.oracle.communications.brm.cc.model.NewBillUnit.BalanceGroups

class BalanceGroups extends Object implements Serializable

Serialized Fields

id

String id

The ID.

Class com.oracle.communications.brm.cc.model.NewBillUnits

class NewBillUnits extends Object implements Serializable

Serialized Fields

accountingCycleDom

Integer accountingCycleDom

The accounting cycle day of month (DOM).

accountingType

Integer accountingType

The accounting type. Can be one of the following:

• 1: Open item
• 2: Balance forward

arBillUnitRef

ResourceRef arBillUnitRef

balanceGroups

List<BalanceGroup> balanceGroups

billingFrequencyInMonths

Integer billingFrequencyInMonths

The billing frequency in number of months. Can be one of the following:

• 1: Monthly
• 2: Bi-monthly
• 3: Quarterly
• 12: Yearly

businessProfile

String businessProfile

The business profile associated with bill unit.

currency

int currency

The primary currency of the bill unit.

effectiveDate

Calendar effectiveDate

The date and time the bill unit takes effect.

forServiceGroup

List<ServiceGroupIndex> forServiceGroup

name

String name

The name of the bill unit.

parentBillUnitRef

ResourceRef parentBillUnitRef

parentRef

String parentRef

A reference to the parent.

paymentMethod

PaymentMethod paymentMethod

paymentMethodId

String paymentMethodId

The ID of the payment method.

paymentType

Integer paymentType

The payment type. Can be one of the following:

• 10001:Invoice
• 10003: Credit card
• 10005: Direct debit
• 10007: Subordinate

rollUp

Boolean rollUp

segment

Integer segment

The customer segment associated with the bill unit. A customer segment is a user-defined customer description that can be used to group accounts according to customer billing and payment practices.

status

String status

The status of the bill unit, such as active, inactive, or closed.

walletPaymentInstrumentIndex

Integer walletPaymentInstrumentIndex

The wallet index number for the payment instrument associated with the bill unit.

Class com.oracle.communications.brm.cc.model.Newsfeed

class Newsfeed extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

Newsfeed's account holder.

amount

BigDecimal amount

The amount held in newsfeed.

billInfoRef

ResourceRef billInfoRef

The newsfeed's bill unit owner.

created

Calendar created

The time when newsfeed object was created.

eventRef

ResourceRef eventRef

The event linked to newsfeed.

externalUser

String externalUser

The external CSR who created this newsfeed.

id

ResourceRef id

The newsfeed object's id.

message

String message

The combination of Id and value used for localizing details.

objectRef

ResourceRef objectRef

The pointer to item, bill or other object related to newsfeed entry.

reasonDomainId

Integer reasonDomainId

The reason code domain id for newsfeed entry.

reasonId

Integer reasonId

The reason code id. It identifies the reason code to which this newsfeed has been assigned.

resourceId

Integer resourceId

Numeric value of the resource that is impacted.

typeId

int typeId

The specific type of newsfeed entry.

typeStr

String typeStr

Additional details related to type of newsfeed.

Class com.oracle.communications.brm.cc.model.Notes

class Notes extends Extension implements Serializable

Serialized Fields

accountId

String accountId

The ID of the account associated with the note.

amount

BigDecimal amount

The amount associated with the note. It can be a payment amount, adjustment amount, or so on.

billId

String billId

The ID of the bill associated with the note.

billUnitId

String billUnitId

The ID of the bill unit associated with the note.

closedDate

Calendar closedDate

The date and time the note was resolved.

comments

List<Notes.Comments> comments

The list of comments associated with the note.

count

Integer count

The number of comments associated with the note.

domainId

Integer domainId

The domain ID associated with the note.

effectiveDate

Calendar effectiveDate

The date and time the comment was posted.

eventId

String eventId

The ID of the event associated with the note.

header

String header

The header associated with the note.

id

String id

The ID.

itemId

String itemId

The ID of the item associated with the note.

reasonId

Integer reasonId

The reason ID associated with the note. Possible values are stored in /config/reason_code_scope objects. See "Localizing and Customizing Strings" in BRM Developer's Guide for information about how to customize these values using the reasons.locale file.

serviceId

String serviceId

The service ID associated with the note.

status

BigDecimal status

The note's status: not set (100), resolved (101), or unresolved (102). The default value is 102.

subType

Integer subType

The note's subtype. Possible values are stored in the /config/note_type object. See "Localizing and Customizing Strings" in BRM Developer's Guide for information about how to customize these values using the note.locale file.

type

Integer type

The note's type. Possible values are stored in the /config/note_type object. See "Localizing and Customizing Strings" in BRM Developer's Guide for information about how to customize these values using the note.locale file.

Class com.oracle.communications.brm.cc.model.Notes.Comments

class Comments extends Object implements Serializable

Serialized Fields

comment

String comment

The comment.

csrAccountId

String csrAccountId

The CSR's account ID.

csrFirstName

String csrFirstName

The CSR's first name.

csrLastName

String csrLastName

The CSR's last name.

csrLoginId

String csrLoginId

The login ID associated with the CSR.

entryDate

Calendar entryDate

The date and time the comment was entered by the CSR.

externalUser

String externalUser

The external user.

trackingId

String trackingId

The tracking ID.

Class com.oracle.communications.brm.cc.model.NotesInfo

class NotesInfo extends Extension implements Serializable

Serialized Fields

notes

Notes notes

Class com.oracle.communications.brm.cc.model.NotificationCriteria

class NotificationCriteria extends Object implements Serializable

Serialized Fields

dataType

Integer dataType

The notification criteria data type. Allowed Values:

• 1 (Integer)
• 3 (Enumeration)
• 5 (String)
• 7 (POID)
• 8 (Timestamp)
• 14 (Decimal)

key

String key

The notification criteria key.

operator

Integer operator

The operator for the qualifier. Allowed values:

• 0 (Equals)
• 1 (Less than)
• 2 (Greater than)
• 3 (Less than or equals)
• 4 (Greater than or equals)
• 5 (Not equal)
• 6 (Contained in string)
• 7 (Like)

value

String value

The notification criteria value.

Class com.oracle.communications.brm.cc.model.NotificationDeliveryMethod

class NotificationDeliveryMethod extends Object implements Serializable

Serialized Fields

id

String id

The notification delivery method ID.

name

String name

The notification delivery method name.

status

Integer status

The notification delivery method status. Allowed Values:

• 1 (Active)
• 2 (Inactive)

Class com.oracle.communications.brm.cc.model.NotificationDeliverySchedule

class NotificationDeliverySchedule extends Object implements Serializable

Serialized Fields

offsetUnit

Integer offsetUnit

The notification delivery schedule offset type. Allowed values:

• 1 (Minute)
• 3 (Hour)
• 4 (Day)
• 5 (Week)
• 2 (Month)
• 0 (Year)

offsetValue

String offsetValue

The notification delivery schedule offset value.

Class com.oracle.communications.brm.cc.model.NotificationDeliverySpec

class NotificationDeliverySpec extends Object implements Serializable

Serialized Fields

dayOfMonth

Integer dayOfMonth

The day of the month.

dayOfWeek

Integer dayOfWeek

The day of the week.

deliveryPeriodEnd

String deliveryPeriodEnd

The notification delivery end time. Pattern: ^([0-1]?\d|2[0-3])(?::([0-5]?\d))?(?::([0-5]?\d))?$

Class com.oracle.communications.brm.cc.model.NotificationEvent

class NotificationEvent extends Object implements Serializable

Serialized Fields

eventName

String eventName

The notification event name.

eventType

String eventType

The event type.

flags

Integer flags

notifySearchLevel

Integer notifySearchLevel

The level to search for the notification. Allowed Values:

• 1 (Own self)
• 2 (Account)
• 4 (Balance group)
• 8 (Service)
• 16 (Bill info)

opcode

Integer opcode

The policy opcode number.

Class com.oracle.communications.brm.cc.model.NotificationSpec

class NotificationSpec extends Object implements Serializable

Serialized Fields

advanceNotifications

List<NotificationDeliverySchedule> advanceNotifications

aggregateMode

Integer aggregateMode

Aggregation mode. Allowed Values: 0 (Send multiple notifications), 1 (Send consolidated single notification with details from all).

category

String category

Free text. Use this field for classification.

createdAt

String createdAt

The creation date for the notification specification.

criteria

List<NotificationCriteria> criteria

deliveryControlFlag

Integer deliveryControlFlag

The notification control flag type. Allowed Values:

• 0 (Always Deliver)
• 1 (No delivery in silent period)

deliveryMethods

List<NotificationDeliveryMethod> deliveryMethods

deliverySpec

List<NotificationDeliverySpec> deliverySpec

descr

String descr

The notification specification description.

expiresAt

String expiresAt

The date when the notification specification expires.

href

String href

The unique resource URL, used to get the notification specification object.

id

String id

The notification specification ID.

modifiedAt

String modifiedAt

The modification date for the notification specification.

name

String name

The notification specification name.

optType

Integer optType

The notification Opt In/Opt Out options. Allowed Values:

• 1 (Requires opt in)
• 2 (Requires opt out)
• 3 (Mandatory)

scope

Integer scope

The notification scope. Allowed Values:

• 1 (System)
• 2 (User)

startsAt

String startsAt

The start date for the notification specification.

status

String status

The notification specification status. Allowed values: ACTIVE, INACTIVE, EXPIRED

systemEvent

String systemEvent

The notification event POID type.

triggerType

Integer triggerType

The notification trigger type. Allowed Values:

• 0 (All)
• 1 (System)
• 2 (Auto)

type

Integer type

The notification type. Allowed Values:

• 1 (Advance)
• 2 (Real-time)
• 3 (Predefined)
• 4 (First transaction)
• 5 (Post-due)

Class com.oracle.communications.brm.cc.model.Offer

class Offer extends Extension implements Serializable

Serialized Fields

id

String id

The ID.

offerDetail

List<OfferDetail> offerDetail

The list of offer details.

Class com.oracle.communications.brm.cc.model.OfferAttributes

class OfferAttributes extends Object implements Serializable

Serialized Fields

attributes

List<OfferAttributes.Attributes> attributes

The list of attributes within offers attribute object.

Class com.oracle.communications.brm.cc.model.OfferAttributes.Attributes

class Attributes extends Object implements Serializable

Serialized Fields

name

String name

The attribute name.

value

String value

The attribute value.

Class com.oracle.communications.brm.cc.model.OfferDetail

class OfferDetail extends Object implements Serializable

Serialized Fields

details

List<OfferDetail.Details> details

The offer details.

event

String event

The event associated with the offer.

Class com.oracle.communications.brm.cc.model.OfferDetail.Details

class Details extends Object implements Serializable

Serialized Fields

balanceImpactResource

String balanceImpactResource

The resource that represents the balance impact of the offer.

fixedAmount

float fixedAmount

The fixed amount of the offer.

fixedPriceTag

String fixedPriceTag

The fixed price tag of the offer.

scaledAmount

float scaledAmount

The scaled amount of the offer.

scaledPriceTag

String scaledPriceTag

The scaled price tag of the offer.

Class com.oracle.communications.brm.cc.model.OfferStatus

class OfferStatus extends Extension implements Serializable

Serialized Fields

chargeOffers

List<OfferStatus.ChargeOffers> chargeOffers

The list of charge offers.

discountOffers

List<OfferStatus.DiscountOffers> discountOffers

The list of discount offers.

effectiveDate

Calendar effectiveDate

The date and time the status takes effect.

notes

Notes notes

statusCode

int statusCode

The code associated with the offer's status. Can be one of the following:

• 0: Not set
• 1: Active
• 2: Inactive
• 3: Canceled

Class com.oracle.communications.brm.cc.model.OfferStatus.ChargeOffers

class ChargeOffers extends Object implements Serializable

Serialized Fields

ref

ResourceRef ref

Class com.oracle.communications.brm.cc.model.OfferStatus.DiscountOffers

class DiscountOffers extends Object implements Serializable

Serialized Fields

ref

ResourceRef ref

Class com.oracle.communications.brm.cc.model.OrganizationHierarchy

class OrganizationHierarchy extends AccountContactDetails implements Serializable

Serialized Fields

children

List<Children> children

The list of child accounts in the organization hierarchy.

numberOfDirectChildren

int numberOfDirectChildren

The number of immediate children of the parent in the organization hierarchy.

organizationHierarchyType

int organizationHierarchyType

The type of organization hierarchy, such as site or legal entity.

parent

Parent parent

The parent in the organization hierarchy.

Class com.oracle.communications.brm.cc.model.OriginalBill

class OriginalBill extends CorrectiveBillDetails implements Serializable

Serialized Fields

originalBill

OriginalBill originalBill

Information about an original bill.

Class com.oracle.communications.brm.cc.model.OverriddenCharges

class OverriddenCharges extends Object implements Serializable

Serialized Fields

charges

List<OverriddenCharges.Charges> charges

The charge details.

event

String event

The event associated with the overridden charges.

Class com.oracle.communications.brm.cc.model.OverriddenCharges.Charges

class Charges extends Object implements Serializable

Serialized Fields

charge

List<OverriddenCharges.Charges.Charge> charge

The charges.

endDate

Calendar endDate

The date and time the charge's validity ends.

startDate

Calendar startDate

The date and time the charge's validity starts.

Class com.oracle.communications.brm.cc.model.OverriddenCharges.Charges.Charge

class Charge extends Object implements Serializable

Serialized Fields

amount

BigDecimal amount

The charge amount.

priceTag

String priceTag

The charge's price tag.

type

String type

The charge type.

Class com.oracle.communications.brm.cc.model.Package

class Package extends PackageType implements Serializable

Class com.oracle.communications.brm.cc.model.PackageBasedOrder

class PackageBasedOrder extends Extension implements Serializable

Serialized Fields

effective

Calendar effective

The date and time the package purchase takes effect.

existingBillunitsForBalanceGroups

List<ExistingBillUnits> existingBillunitsForBalanceGroups

genericBundle

CustomizedBundleForPurchase genericBundle

newBillunitsForBalanceGroups

List<NewBillUnits> newBillunitsForBalanceGroups

notes

Notes notes

purchasingPackageRef

String purchasingPackageRef

The resource associated with the package purchase.

services

List<PurchasingService> services

Class com.oracle.communications.brm.cc.model.PackageList

class PackageList extends Extension implements Serializable

Serialized Fields

_package

List<Package> _package

A package.

Class com.oracle.communications.brm.cc.model.PackageTransition

class PackageTransition extends Extension implements Serializable

Serialized Fields

fromPackage

String fromPackage

The package the account is transitioning from.

genericBundle

CustomizedBundleForPurchase genericBundle

mappedServiceIds

List<String> mappedServiceIds

The list of service IDs.

notes

Notes notes

services

List<PurchasingService> services

toPackage

String toPackage

The package the account is transitioning to.

transitionOn

String transitionOn

BRM service type on which transition will take place. For example, '/service/ip', '/service/telco/gsm/telephony'.

transitionType

int transitionType

The type of transition, such as upgrade, downgrade, generation change, or a custom transition type.

Class com.oracle.communications.brm.cc.model.PackageType

class PackageType extends Object implements Serializable

Serialized Fields

balanceGroups

List<PackageType.BalanceGroups> balanceGroups

Balance groups associated with the package.

creationDate

Calendar creationDate

The date and time the package was created.

description

String description

The package's description.

id

String id

The ID.

lastModified

Calendar lastModified

The date and time the package was last modified.

name

String name

The package's name.

packageId

Integer packageId

The package's ID.

purchaseFeeWaived

Boolean purchaseFeeWaived

Whether to waive the purchase fee for the package (true) or not (false). The default is (false).

serviceGroup

List<GroupOfServices> serviceGroup

serviceIds

List<String> serviceIds

The list of service IDs associated with the package.

subscriptionTerms

SubscriptionTerms subscriptionTerms

tags

String tags

The tags associated with the package.

terminationFeeWaived

Boolean terminationFeeWaived

Whether to waive the termination fee for the package (true) or not (false). The default is (false).

validTo

Calendar validTo

The end date for the package's validity.

Class com.oracle.communications.brm.cc.model.PackageType.BalanceGroups

class BalanceGroups extends Object implements Serializable

Serialized Fields

_default

Boolean _default

Whether this is the default balance group (true) or not (false). The default is (false).

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

limits

List<LimitType> limits

name

String name

The name of the balance group.

rules

List<PackageType.BalanceGroups.Rules> rules

The list of consumption rules that define the order in which to consume balances.

Class com.oracle.communications.brm.cc.model.PackageType.BalanceGroups.Rules

class Rules extends Object implements Serializable

Serialized Fields

consumptionRule

String consumptionRule

The consumption rule. Can be one of the following:

• 0: Not defined
• 1: Earliest start time
• 2: Latest start time
• 3: Earliest expiration time
• 4: Latest expiration time
• 5: Earliest start time and latest expiration time
• 6: Earliest start time and earliest expiration time
• 7: Latest start time and earliest expiration time
• 8: Latest start time and latest expiration time
• 9: Earliest expiration time and earliest start time
• 10: Earliest expiration time and latest start time
• 10: Latest expiration time and earliest start time
• 10: Latest expiration time and latest start time

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

Class com.oracle.communications.brm.cc.model.ParamInfo

class ParamInfo extends Extension implements Serializable

Serialized Fields

errorDescription

String errorDescription

errorIndex

Integer errorIndex

fieldName

String fieldName

paramInfo

List<ParamInfo> paramInfo

Class com.oracle.communications.brm.cc.model.Parent

class Parent extends AccountContactDetails implements Serializable

Serialized Fields

organizationHierarchyType

int organizationHierarchyType

The type of organization hierarchy, such as not set, site, legal entity, billing account, or service account.

parent

Parent parent

The parent in the organization hierarchy.

Class com.oracle.communications.brm.cc.model.PartialRefund

class PartialRefund extends FullRefund implements Serializable

Serialized Fields

amount

BigDecimal amount

The amount that was refunded.

Class com.oracle.communications.brm.cc.model.PayinfoCc

class PayinfoCc extends PayinfoCcType implements Serializable

Class com.oracle.communications.brm.cc.model.PayinfoCcType

class PayinfoCcType extends PaymentTypeBase implements Serializable

Serialized Fields

ccInfo

List<PayinfoCcType.CcInfo> ccInfo

The credit card information.

Class com.oracle.communications.brm.cc.model.PayinfoCcType.CcInfo

class CcInfo extends Object implements Serializable

Serialized Fields

address

String address

The street address associated with the credit card.

city

String city

The city associated with the credit card.

country

String country

The country associated with the credit card.

debitExp

String debitExp

The credit card expiry date in mmyy format.

debitNum

String debitNum

The credit card number.

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

name

String name

The name on the credit card.

securityCode

String securityCode

The credit card's 3-digit CVV2 or 4-digit CID.

state

String state

The state associated with the credit card.

zip

String zip

The ZIP code associated with the credit card.

Class com.oracle.communications.brm.cc.model.PayinfoDd

class PayinfoDd extends PayinfoDdType implements Serializable

Class com.oracle.communications.brm.cc.model.PayinfoDdType

class PayinfoDdType extends PaymentTypeBase implements Serializable

Serialized Fields

ddInfo

List<PayinfoDdType.DdInfo> ddInfo

The direct debit information.

Class com.oracle.communications.brm.cc.model.PayinfoDdType.DdInfo

class DdInfo extends Object implements Serializable

Serialized Fields

accountType

int accountType

The bank account type. Can be one of the following:

• 1: Checking
• 2: Savings
• 3: Corporate

address

String address

The street address associated with the bank account.

bankNo

String bankNo

The RDFI or Bank ID used for routing transactions.

city

String city

The city associated with the bank account.

country

String country

The country associated with the bank account.

ddActivationDate

Calendar ddActivationDate

The date and time the card was activated.

debitNum

String debitNum

The customer's bank account number.

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

fiasId

String fiasId

The FIAS ID.

mandateStatus

int mandateStatus

The mandate status.

manReceivedDate

Calendar manReceivedDate

The date and time the mandate was received.

name

String name

The name associated with the bank account.

state

String state

The state associated with the bank account.

zip

String zip

The ZIP code associated with the bank account.

Class com.oracle.communications.brm.cc.model.PayinfoInvoice

class PayinfoInvoice extends PayinfoInvoiceType implements Serializable

Class com.oracle.communications.brm.cc.model.PayinfoInvoiceType

class PayinfoInvoiceType extends PaymentTypeBase implements Serializable

Serialized Fields

invInfo

List<PayinfoInvoiceType.InvInfo> invInfo

The invoice information.

Class com.oracle.communications.brm.cc.model.PayinfoInvoiceType.InvInfo

class InvInfo extends Object implements Serializable

Serialized Fields

address

String address

The street address associated with the invoice.

city

String city

The city associated with the invoice.

country

String country

The country associated with the invoice.

deliveryDesc

String deliveryDesc

The invoice delivery description.

deliveryPrefer

String deliveryPrefer

The customer's invoice delivery preference. Can be one of the following:

• 0: Email
• 1: Postal
• 2: Fax

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

emailAddr

String emailAddr

The email address associated with the invoice.

invInstr

String invInstr

The invoice instructions.

invoiceId

String invoiceId

The invoice's ID.

invTerms

String invTerms

The terms associated with the invoice.

name

String name

The name associated with the invoice.

state

String state

The state associated with the invoice.

zip

String zip

The ZIP code associated with the invoice.

Class com.oracle.communications.brm.cc.model.PayinfoType

class PayinfoType extends Extension implements Serializable

Serialized Fields

accountObj

ResourceRef accountObj

creationDate

Calendar creationDate

The date and time the payment type was created.

id

ResourceRef id

name

String name

The name of the payment type.

paymentType

Integer paymentType

The payment type.

Class com.oracle.communications.brm.cc.model.Payment

class Payment extends Extension implements Serializable

Serialized Fields

amount

BigDecimal amount

The payment amount.

currency

int currency

The payment's currency.

itemPaymentRef

String itemPaymentRef

The item associated with the payment.

notes

Notes notes

payinfoTypeObject

PaymentTypeBase payinfoTypeObject

selectedBillUnit

String selectedBillUnit

The bill unit associated with the payment.

Class com.oracle.communications.brm.cc.model.PaymentAuditDetails

class PaymentAuditDetails extends PaymentAuditDetailsType implements Serializable

Class com.oracle.communications.brm.cc.model.PaymentAuditDetailsType

class PaymentAuditDetailsType extends Extension implements Serializable

Serialized Fields

accountNumber

String accountNumber

The account number.

accountRef

ResourceRef accountRef

activityDate

Calendar activityDate

The date and time the payment activity occurred.

amount

BigDecimal amount

The amount of the payment.

csrLoginId

String csrLoginId

The CSR's login ID.

domainId

int domainId

The domain ID. 14 is for payment suspense management. 15 is for payment suspense action owners. 16 is for payment suspense reversals.

firstName

String firstName

The first name associated with the account.

lastName

String lastName

The last name associated with the account.

paymentItemRef

ResourceRef paymentItemRef

paymentTypeEventRef

ResourceRef paymentTypeEventRef

reasonId

int reasonId

The ID of the reason code.

status

int status

The status of the payment. Successful payment statuses are 0 to 14. Suspended payment statuses are 15 to 29. Failed payment statuses are 30 to 44.

subTransactionId

String subTransactionId

The subtransaction ID.

transactionId

String transactionId

The transaction ID.

Class com.oracle.communications.brm.cc.model.PaymentBatchFileHeader

class PaymentBatchFileHeader extends Extension implements Serializable

Serialized Fields

currency

String currency

The currency of all payments in the batch payment file.

fileCreationDate

Calendar fileCreationDate

The date and time the batch payment file was created.

fileName

String fileName

The file name for the batch payment file.

fileSize

double fileSize

The size of the batch payment file.

institutionName

String institutionName

The name of the institution that created the batch payment file.

lockBoxId

String lockBoxId

The lockbox's ID.

lockBoxName

String lockBoxName

The lockbox's name.

noOfPayments

long noOfPayments

The number of payments in the batch payment file.

status

Integer status

The status of the batch payment file. Can be one of the following:

• 1: New
• 2: Format error
• 3: Unknown template
• 4: Processing error
• 5: Threshold exceeded
• 6: Processing

templateName

String templateName

The template name.

Class com.oracle.communications.brm.cc.model.PaymentBatchStatistics

class PaymentBatchStatistics extends Extension implements Serializable

Serialized Fields

batchCurrency

int batchCurrency

The currency of all payments in the batch payment file.

batchRef

ResourceRef batchRef

durationInQueue

int durationInQueue

The amount of time that the batch payment file was in the BRM queue.

durationProcessed

int durationProcessed

The amount of time that the batch payment file was being processed by BRM.

fileCreationDate

Calendar fileCreationDate

The date and time the batch payment file was created.

fileName

String fileName

The name of the batch payment file.

fileSize

double fileSize

The size of the batch payment file.

institutionName

String institutionName

The name of the institution, such as a commercial bank, that processed the batch payment.

lockBoxId

String lockBoxId

The lockbox's ID.

lockBoxName

String lockBoxName

The lockbox's name.

processCompletionDate

Calendar processCompletionDate

The date BRM completed processing the batch payment file.

processedBy

String processedBy

The company that processed the lockbox payments.

processEndDate

Calendar processEndDate

The date BRM stopped processing the batch payment file.

processStartDate

Calendar processStartDate

The date BRM started processing the batch payment file.

queueStartDate

Calendar queueStartDate

The date the batch payment file started wait in queue.

totalAmount

BigDecimal totalAmount

The total amount of all payments in the batch payment file.

totalPayments

int totalPayments

The total number of payments in the batch payment file.

totalPaymentsProcessed

int totalPaymentsProcessed

The total number of payments that have been processed.

totalPaymentsSuspended

int totalPaymentsSuspended

The total number of payments that were suspended.

Class com.oracle.communications.brm.cc.model.PaymentChannel

class PaymentChannel extends Object implements Serializable

Serialized Fields

channelId

int channelId

The ID of the payment channel.

channelName

String channelName

The name of the payment channel.

Class com.oracle.communications.brm.cc.model.PaymentDetails

class PaymentDetails extends Extension implements Serializable

Serialized Fields

accountId

String accountId

The ID of the account.

allocatedAmount

BigDecimal allocatedAmount

The amount of the payment that has been allocated.

billDetails

List<PaymentDetails.BillDetails> billDetails

The list of bill details associated with the payment.

currencyId

Integer currencyId

The currency ID of the payment.

eventRef

ResourceRef eventRef

notes

List<Notes> notes

originalPaymentAmount

BigDecimal originalPaymentAmount

The amount paid against the original bill.

originalPaymentDetails

PaymentDetails.OriginalPaymentDetails originalPaymentDetails

payinfoTypeObject

PaymentTypeBase payinfoTypeObject

paymentAction

Integer paymentAction

Whether the payment has been reversed or suspended. Can be one of the following:

• 0: Not reversed.
• 1: Reversed.
• 2: Suspended.

paymentAuditDetails

List<PaymentAuditDetailsType> paymentAuditDetails

paymentId

String paymentId

The ID of the payment.

paymentType

Long paymentType

The payment type. Can be one of the following:

• 10001:Invoice
• 10003: Credit card
• 10005: Direct debit
• 10007: Subordinate

postedDate

Calendar postedDate

The date and time the payment was posted.

receiptDate

Calendar receiptDate

The date and time the payment receipt was issued.

refundedDetails

List<PaymentDetails.RefundedDetails> refundedDetails

reversalAmount

BigDecimal reversalAmount

The amount of the payment reversal.

reversalDate

Calendar reversalDate

The date and time the payment reversal occurred.

reversalId

String reversalId

The ID of the payment reversal.

subTransactionId

String subTransactionId

The ID of the subtransaction.

transactionId

String transactionId

The ID of the transaction.

unallocatedAmount

BigDecimal unallocatedAmount

The amount of the payment that hasn't been allocated yet.

Class com.oracle.communications.brm.cc.model.PaymentDetails.BillDetails

class BillDetails extends Object implements Serializable

Serialized Fields

accountNumber

String accountNumber

The account number associated with the bill.

billId

String billId

The bill ID.

billUnitId

String billUnitId

The ID for the bill unit associated with the bill.

cycleEnds

Calendar cycleEnds

The date and time the billing cycle ends.

cycleStarts

Calendar cycleStarts

The date and time the billing cycle starts.

dueAmount

BigDecimal dueAmount

The total amount due.

dueDate

Calendar dueDate

The due date for the bill.

itemsAffected

List<PaymentDetails.BillDetails.ItemsAffected> itemsAffected

Affected bill items.

itemsAffectedCount

long itemsAffectedCount

The number of bill items affected by the bill.

Class com.oracle.communications.brm.cc.model.PaymentDetails.BillDetails.ItemsAffected

class ItemsAffected extends Object implements Serializable

Serialized Fields

accountNumber

String accountNumber

The account number associated with the bill item.

amount

BigDecimal amount

The bill item amount.

billNumber

String billNumber

The bill number associated with the bill item.

billUnitId

String billUnitId

The ID of the bill unit associated with the bill item.

cycleEnds

Calendar cycleEnds

The date and time the billing cycle ends.

cycleStarts

Calendar cycleStarts

The date and time the billing cycle starts.

item

String item

The bill item.

settledNonTaxedAmount

BigDecimal settledNonTaxedAmount

The nontaxable amount for the bill item settled by the payment.

settledTaxAmount

BigDecimal settledTaxAmount

The amount of tax for the bill item settled by the payment.

settledTaxedAmount

BigDecimal settledTaxedAmount

The taxable amount for the bill item settled by the payment.

Class com.oracle.communications.brm.cc.model.PaymentDetails.OriginalPaymentDetails

class OriginalPaymentDetails extends Object implements Serializable

Serialized Fields

accountId

String accountId

The account ID.

paymentId

String paymentId

The payment ID.

paymentItemNumber

String paymentItemNumber

The payment item number.

Class com.oracle.communications.brm.cc.model.PaymentDetails.RefundedDetails

class RefundedDetails extends Object implements Serializable

Serialized Fields

amount

BigDecimal amount

item

String item

itemRef

ResourceRef itemRef

Class com.oracle.communications.brm.cc.model.PaymentInstrumentType

class PaymentInstrumentType extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

correctiveInvoiceType

Integer correctiveInvoiceType

The type of invoice to create, such as an invoice correction letter or a replacement invoice.

id

String id

The ID.

name

String name

The payment instrument's name.

paymentType

Integer paymentType

The payment type. Can be one of the following:

• 10001:Invoice
• 10003: Credit card
• 10005: Direct debit
• 10007: Subordinate

Class com.oracle.communications.brm.cc.model.PaymentList

class PaymentList extends Extension implements Serializable

Serialized Fields

billingStatus

Integer billingStatus

The billing status. Allowed values:

• 1 (Billed)
• 2 (Unbilled)

originalPaymentAmount

BigDecimal originalPaymentAmount

The original payment amount.

paymentAction

Integer paymentAction

Whether the payment has been reversed or suspended. Allowed values:

• 0 (Not reversed)
• 1 (Reversed)
• 2 (Suspended)

paymentAmount

BigDecimal paymentAmount

The amount of the payment.

paymentDate

Calendar paymentDate

The date and time the payment was made.

paymentId

String paymentId

The ID of the payment

paymentMethod

int paymentMethod

The payment method. Allowed values:

• 10011 (Cash)
• 10012 (Check)
• 10013 (Wire transfer)
• 10014 (Inter-bank payment order)
• 10015 (Postal order)

paymentRef

ResourceRef paymentRef

unAllocatedAmount

BigDecimal unAllocatedAmount

The amount that is still unallocated.

Class com.oracle.communications.brm.cc.model.PaymentMethod

class PaymentMethod extends Extension implements Serializable

Serialized Fields

creditCard

CreditCardType creditCard

directDebit

DirectDebitType directDebit

invoice

InvoiceType invoice

paymentType

Integer paymentType

The payment type. Can be one of the following:

• 10001:Invoice
• 10003: Credit card
• 10005: Direct debit
• 10007: Subordinate

sepa

SepaType sepa

Class com.oracle.communications.brm.cc.model.PaymentMethods

class PaymentMethods extends Extension implements Serializable

Serialized Fields

paymentMethods

Wallet paymentMethods

Class com.oracle.communications.brm.cc.model.PaymentTypeBase

class PaymentTypeBase extends PayinfoType implements Serializable

Class com.oracle.communications.brm.cc.model.PaymentTypeFields

class PaymentTypeFields extends Object implements Serializable

Serialized Fields

paymentMethodFields

List<PaymentTypeFields.PaymentMethodFields> paymentMethodFields

Payment fields of default type and language type.

Class com.oracle.communications.brm.cc.model.PaymentTypeFields.PaymentMethodFields

class PaymentMethodFields extends Object implements Serializable

Serialized Fields

languageName

String languageName

Type of paymenttool object based on language.

paymentMethodObjectID

String paymentMethodObjectID

Paymenttool object unique ID.

paymentMethodType

List<PaymentTypeFields.PaymentMethodFields.PaymentMethodType> paymentMethodType

Fields related to a particular payment method.

Class com.oracle.communications.brm.cc.model.PaymentTypeFields.PaymentMethodFields.PaymentMethodType

class PaymentMethodType extends Object implements Serializable

Serialized Fields

fields

List<PaymentTypeFields.PaymentMethodFields.PaymentMethodType.Fields> fields

paymentMethodID

int paymentMethodID

Payment type unique ID.

paymentMethodName

String paymentMethodName

Name of type of payment.

Class com.oracle.communications.brm.cc.model.PaymentTypeFields.PaymentMethodFields.PaymentMethodType.Fields

class Fields extends Object implements Serializable

Serialized Fields

batchType

int batchType

Type of Batch-reversal or payment.

columnName

String columnName

Name of field displayed.

fieldName

String fieldName

Name of fields in batch.

purpose

int purpose

Whether the field can be modified (0) or is read-only (1).

typeID

int typeID

The data type of the value. Allowed values:

• 1 (Integer)
• 3 (Enumerated)
• 5 (String)
• 7 (POID)
• 8 (Timestamp)
• 14 (Decimal)

Class com.oracle.communications.brm.cc.model.PayMethod

class PayMethod extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

assignedBillUnits

List<String> assignedBillUnits

Bill units assigned to the payment method.

creditCard

CreditCardType creditCard

deassignedBillUnits

List<String> deassignedBillUnits

Bill units to be disassociated from the payment method.

directDebit

DirectDebitType directDebit

invoice

InvoiceType invoice

paymentType

Integer paymentType

The payment type. Can be one of the following:

• 0 (Undefined)
• 10000 (Prepaid)
• 10001 (Invoice)
• 10002 (Debit card)
• 10003 (Credit card)
• 10005 (US or Canada direct debit)
• 10006 (Smartcard)
• 10007 (Subordinate)
• 10011 (Cash)
• 10012 (Check)
• 10013 (Wire transfer)
• 10014 (Inter-bank payment order)
• 10015 (Postal payment order)
• 10016 (Voucher)
• 10017 (Failed payment)
• 10018 (SEPA payment)

sepa

SepaType sepa

Class com.oracle.communications.brm.cc.model.Plan

class Plan extends Object implements Serializable

Serialized Fields

code

String code

The plan's code.

createdAt

String createdAt

The date the plan was created.

desc

String desc

The plan's description.

id

String id

The plan's ID.

name

String name

The plan's name.

Class com.oracle.communications.brm.cc.model.Preferences

class Preferences extends Extension implements Serializable

Serialized Fields

preference

List<Preferences.Preference> preference

A preference.

Class com.oracle.communications.brm.cc.model.Preferences.Preference

class Preference extends Object implements Serializable

Serialized Fields

key

String key

A preference key.

value

String value

A preference value.

Class com.oracle.communications.brm.cc.model.Product

class Product extends Extension implements Serializable

Serialized Fields

contractEndDate

Calendar contractEndDate

The end date for the contract.

contractName

String contractName

The name of the contract.

contractRef

ResourceRef contractRef

contractStartDate

Calendar contractStartDate

The start date for the contract.

description

String description

The product's description.

id

ResourceRef id

isOfferCustomized

boolean isOfferCustomized

Whether the product contains customized offers (true) or not (false).

lastStatusChange

Calendar lastStatusChange

The date and time the product's status was last changed.

name

String name

The product's name.

planName

String planName

The name of the package that contains the product.

productRef

ResourceRef productRef

purchaseDate

Calendar purchaseDate

The date and time the product was purchased.

purchaseEndDate

Calendar purchaseEndDate

The date and time the purchase ends.

status

String status

The product's status.

termRef

ResourceRef termRef

type

int type

The type of product. Can be one of the following:

• 0: Optional
• 1: Required
• 2: Regular

Class com.oracle.communications.brm.cc.model.ProfileAcctExtrating

class ProfileAcctExtrating extends ProfileAcctExtratingType implements Serializable

Class com.oracle.communications.brm.cc.model.ProfileAcctExtratingType

class ProfileAcctExtratingType extends ProfileBase implements Serializable

Serialized Fields

dataArray

List<ProfileAcctExtratingType.DataArray> dataArray

A list of extended rating attributes (ERAs).

Class com.oracle.communications.brm.cc.model.ProfileAcctExtratingType.DataArray

class DataArray extends Object implements Serializable

Serialized Fields

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

name

String name

The ERA's name.

validFrom

Calendar validFrom

The date when the ERA's validity period starts.

validTo

Calendar validTo

The date when the ERA's validity period ends.

value

String value

The ERA's value.

Class com.oracle.communications.brm.cc.model.ProfileBase

class ProfileBase extends ProfileType implements Serializable

Class com.oracle.communications.brm.cc.model.ProfileCollectionsParams

class ProfileCollectionsParams extends ProfileCollectionsParamsType implements Serializable

Class com.oracle.communications.brm.cc.model.ProfileCollectionsParamsType

class ProfileCollectionsParamsType extends ProfileBase implements Serializable

Serialized Fields

collectionsParams

List<ProfileCollectionsParamsType.CollectionsParams> collectionsParams

Class com.oracle.communications.brm.cc.model.ProfileCollectionsParamsType.CollectionsParams

class CollectionsParams extends Object implements Serializable

Serialized Fields

billinfoObj

ResourceRef billinfoObj

elem

Integer elem

Class com.oracle.communications.brm.cc.model.ProfileCredscoreType

class ProfileCredscoreType extends ProfileBase implements Serializable

Serialized Fields

customInfo

ProfileCredscoreType.CustomInfo customInfo

Class com.oracle.communications.brm.cc.model.ProfileCredscoreType.CustomInfo

class CustomInfo extends Object implements Serializable

Serialized Fields

dn

String dn

type

String type

Class com.oracle.communications.brm.cc.model.ProfileCustomerCare

class ProfileCustomerCare extends ProfileCustomerCareType implements Serializable

Class com.oracle.communications.brm.cc.model.ProfileCustomerCareType

class ProfileCustomerCareType extends ProfileBase implements Serializable

Serialized Fields

customerCareInfo

ProfileCustomerCareType.CustomerCareInfo customerCareInfo

Class com.oracle.communications.brm.cc.model.ProfileCustomerCareType.CustomerCareInfo

class CustomerCareInfo extends Object implements Serializable

Serialized Fields

customerType

Integer customerType

organizationHierarchyType

Integer organizationHierarchyType

Class com.oracle.communications.brm.cc.model.ProfileEventOrdering

class ProfileEventOrdering extends ProfileEventOrderingType implements Serializable

Class com.oracle.communications.brm.cc.model.ProfileEventOrderingType

class ProfileEventOrderingType extends ProfileBase implements Serializable

Serialized Fields

oodCriteria

List<ProfileEventOrderingType.OodCriteria> oodCriteria

Class com.oracle.communications.brm.cc.model.ProfileEventOrderingType.OodCriteria

class OodCriteria extends Object implements Serializable

Serialized Fields

balanceGroup

ResourceRef balanceGroup

billCycleT

Calendar billCycleT

criteriaName

String criteriaName

elem

Integer elem

lastEventProcessT

Calendar lastEventProcessT

Class com.oracle.communications.brm.cc.model.ProfileFields

class ProfileFields extends Extension implements Serializable

Serialized Fields

fields

List<ProfileFields.Fields> fields

The list of profile fields.

storableClass

String storableClass

The storable class associated with the profile field.

Class com.oracle.communications.brm.cc.model.ProfileFields.Fields

class Fields extends Object implements Serializable

Serialized Fields

attribute

String attribute

The field's attribute.

desc

String desc

The field's description.

index

int index

The position of the entry in the index. For example, the first service in a list would have an index value of 1.

label

String label

The field's label.

type

String type

The field type. Can be one of the following:

• integer
• decimal
• string
• date

Class com.oracle.communications.brm.cc.model.ProfileLdap

class ProfileLdap extends ProfileLdapType implements Serializable

Class com.oracle.communications.brm.cc.model.ProfileLdapType

class ProfileLdapType extends ProfileBase implements Serializable

Serialized Fields

ldapInfo

ProfileLdapType.LdapInfo ldapInfo

Class com.oracle.communications.brm.cc.model.ProfileLdapType.LdapInfo

class LdapInfo extends Object implements Serializable

Serialized Fields

dn

String dn

Class com.oracle.communications.brm.cc.model.ProfileLoan

class ProfileLoan extends ProfileLoanType implements Serializable

Class com.oracle.communications.brm.cc.model.ProfileLoanType

class ProfileLoanType extends ProfileBase implements Serializable

Serialized Fields

limit

List<ProfileLoanType.Limit> limit

loanInfo

ProfileLoanType.LoanInfo loanInfo

serviceId

String serviceId

Class com.oracle.communications.brm.cc.model.ProfileLoanType.Limit

class Limit extends Object implements Serializable

Serialized Fields

creditLimit

BigDecimal creditLimit

elem

Integer elem

validFrom

Calendar validFrom

validTo

Calendar validTo

Class com.oracle.communications.brm.cc.model.ProfileLoanType.LoanInfo

class LoanInfo extends Object implements Serializable

Serialized Fields

configLoanObj

ResourceRef configLoanObj

creditAmount

BigDecimal creditAmount

cycleT

Calendar cycleT

externalEligibility

Integer externalEligibility

frequency

Integer frequency

loanThresholds

String loanThresholds

loanThresholdsFixed

String loanThresholdsFixed

maxActiveLoans

Integer maxActiveLoans

numberOfLoans

Integer numberOfLoans

optLoan

Integer optLoan

profileName

String profileName

pullback

Integer pullback

repaymentDays

Integer repaymentDays

unit

Integer unit

Class com.oracle.communications.brm.cc.model.ProfileMostcalled

class ProfileMostcalled extends ProfileMostcalledType implements Serializable

Class com.oracle.communications.brm.cc.model.ProfileMostcalledType

class ProfileMostcalledType extends ProfileBase implements Serializable

Serialized Fields

mostCalledInfo

ProfileMostcalledType.MostCalledInfo mostCalledInfo

Class com.oracle.communications.brm.cc.model.ProfileMostcalledType.MostCalledInfo

class MostCalledInfo extends Object implements Serializable

Serialized Fields

count

Integer count

criterion

String criterion

eventType

String eventType

impactCategory

String impactCategory

offeringObj

ResourceRef offeringObj

Class com.oracle.communications.brm.cc.model.ProfileRolloverTransfer

class ProfileRolloverTransfer extends ProfileRolloverTransferType implements Serializable

Class com.oracle.communications.brm.cc.model.ProfileRolloverTransferType

class ProfileRolloverTransferType extends ProfileBase implements Serializable

Serialized Fields

resourceInfo

List<ProfileRolloverTransferType.ResourceInfo> resourceInfo

Class com.oracle.communications.brm.cc.model.ProfileRolloverTransferType.ResourceInfo

class ResourceInfo extends Object implements Serializable

Serialized Fields

balanceGroup

ResourceRef balanceGroup

elem

Integer elem

recipients

List<ProfileRolloverTransferType.ResourceInfo.Recipients> recipients

Class com.oracle.communications.brm.cc.model.ProfileRolloverTransferType.ResourceInfo.Recipients

class Recipients extends Object implements Serializable

Serialized Fields

balanceGroup

ResourceRef balanceGroup

elem

Integer elem

serviceObj

ResourceRef serviceObj

validFrom

Calendar validFrom

validTo

Calendar validTo

Class com.oracle.communications.brm.cc.model.ProfileServExtrating

class ProfileServExtrating extends ProfileServExtratingType implements Serializable

Class com.oracle.communications.brm.cc.model.ProfileServExtratingType

class ProfileServExtratingType extends ProfileBase implements Serializable

Serialized Fields

dataArray

List<ProfileServExtratingType.DataArray> dataArray

A list of extended rating attributes (ERAs).

extrating

ProfileServExtratingType.Extrating extrating

Information about an extended rating attribute.

Class com.oracle.communications.brm.cc.model.ProfileServExtratingType.DataArray

class DataArray extends Object implements Serializable

Serialized Fields

elem

Integer elem

The position of the entry in the array. For example, the first item in the array would have an elem value of 1.

name

String name

The ERA's name.

validFrom

Calendar validFrom

The date and time the ERA's validity period starts.

validTo

Calendar validTo

The date and time the ERA's validity period ends.

value

String value

The ERA's value.

Class com.oracle.communications.brm.cc.model.ProfileServExtratingType.Extrating

class Extrating extends Object implements Serializable

Serialized Fields

label

String label

The ERA's label name.

referenceCount

Integer referenceCount

A number that keeps the reference count. For purchases, the counter is incremented by one. For cancellations, the counter is decreased by one.

status

Integer status

The provisioning status. Can be one of the following:

• 0: No operation
• 1: Provisioning ERA
• 2: Provisioning ERA failed
• 3: ERA active
• 4: Unprovisioning ERA
• 5: Unprovisioning ERA failed
• 6: ERA unprovisioned
• 7: Suspending ERA
• 8: ERA suspension failed
• 9: ERA suspended

Class com.oracle.communications.brm.cc.model.ProfileSubscriberPreferences

class ProfileSubscriberPreferences extends ProfileSubscriberPreferencesType implements Serializable

Class com.oracle.communications.brm.cc.model.ProfileSubscriberPreferencesType

class ProfileSubscriberPreferencesType extends ProfileBase implements Serializable

Serialized Fields

subscriberPreferences

List<ProfileSubscriberPreferencesType.SubscriberPreferences> subscriberPreferences

A list of subscriber preferences.

Class com.oracle.communications.brm.cc.model.ProfileSubscriberPreferencesType.SubscriberPreferences

class SubscriberPreferences extends Object implements Serializable

Serialized Fields

elem

Integer elem

The position of the entry in the array. For example, the first item in the array would have an elem value of 1.

name

String name

The preference's name.

subscriberPreferenceId

Integer subscriberPreferenceId

The preference's ID.

value

String value

The preference's value.

Class com.oracle.communications.brm.cc.model.ProfileType

class ProfileType extends Extension implements Serializable

Serialized Fields

accountObj

ResourceRef accountObj

creationDate

Calendar creationDate

The date and time the profile was created.

effectiveDate

Calendar effectiveDate

The date and time the profile is effective from.

id

ResourceRef id

multiValued

Boolean multiValued

Whether the profile has multiple values (true) or not (false).

name

String name

The name of the profile.

parentName

String parentName

The name of the parent profile.

selected

boolean selected

Whether the profile is selected (true) or not (false).

serviceObj

ResourceRef serviceObj

Class com.oracle.communications.brm.cc.model.ProfileWriteoff

class ProfileWriteoff extends ProfileWriteoffType implements Serializable

Class com.oracle.communications.brm.cc.model.ProfileWriteoffType

class ProfileWriteoffType extends ProfileBase implements Serializable

Serialized Fields

writeoffInfo

List<ProfileWriteoffType.WriteoffInfo> writeoffInfo

The writeoff information.

Class com.oracle.communications.brm.cc.model.ProfileWriteoffType.WriteoffInfo

class WriteoffInfo extends Object implements Serializable

Serialized Fields

elem

Integer elem

The position of the entry in the array. For example, the first item in the array would have an elem value of 1.

flags

Integer flags

The writeoff flags.

itemObj

ResourceRef itemObj

Class com.oracle.communications.brm.cc.model.PromiseToPay

class PromiseToPay extends Extension implements Serializable

Serialized Fields

amountPerMilestone

BigDecimal amountPerMilestone

The amount of each installment to be paid.

daysBetweenMilestones

Integer daysBetweenMilestones

The number of days between each installment.

daysToPayAmount

Integer daysToPayAmount

The number of days until the payment is completed.

effectiveDate

Calendar effectiveDate

The date and time the promise-to-pay agreement is effective.

milestones

List<PromiseToPay.Milestones> milestones

notes

Notes notes

numberOfMilestones

Integer numberOfMilestones

The number of installments to be paid.

paymentRef

ResourceRef paymentRef

promiseToPayAmount

BigDecimal promiseToPayAmount

The amount that is agreed to be paid.

specName

String specName

Class com.oracle.communications.brm.cc.model.PromiseToPay.Milestones

class Milestones extends Object implements Serializable

Serialized Fields

amount

BigDecimal amount

interval

Integer interval

type

Integer type

Class com.oracle.communications.brm.cc.model.PurchasedBundle

class PurchasedBundle extends Extension implements Serializable

Serialized Fields

bundleID

String bundleID

The bundle's ID.

bundleName

String bundleName

The bundle's name.

bundleType

int bundleType

The type of bundle. Can be one of the following:

• 0: Optional
• 1: Required
• 2: Add-on

packageId

String packageId

The ID of the package that contains the bundle.

Class com.oracle.communications.brm.cc.model.PurchasingService

class PurchasingService extends Object implements Serializable

Serialized Fields

balanceGroupRef

ResourceRef balanceGroupRef

balGrpIndex

Integer balGrpIndex

The balance group index.

customizedBundles

List<CustomizedBundleForPurchase> customizedBundles

devices

List<PurchasingService.Devices> devices

The list of devices associated with the service.

groupParent

Boolean groupParent

Whether this is a parent in a service group (true) or not (false).

profiles

List<ProfileBase> profiles

service

ServiceBase service

serviceKey

String serviceKey

The service key.

serviceType

String serviceType

The service type.

subscriptionIndex

Integer subscriptionIndex

The subscription index.

Class com.oracle.communications.brm.cc.model.PurchasingService.Devices

class Devices extends Object implements Serializable

Serialized Fields

description

String description

A device's description.

id

String id

The device ID.

Class com.oracle.communications.brm.cc.model.Qualifier

class Qualifier extends Object implements Serializable

Serialized Fields

dataType

Integer dataType

The data type of the value. Allowed values:

• 1 (Integer)
• 3 (Enumerated)
• 5 (String)
• 7 (POID)
• 8 (Timestamp)
• 14 (Decimal)

key

String key

The name or the identifier from a storable class.

operator

Integer operator

The operator for the qualifier. Allowed values:

• 0 (Equals)
• 1 (Less than)
• 2 (Greater than)
• 3 (Less than or equals)
• 4 (Greater than or equals)
• 5 (Not equal)
• 6 (Contained in string)
• 7 (Like)

value

String value

The reference value to be evaluated.

Class com.oracle.communications.brm.cc.model.ReasonCodeType

class ReasonCodeType extends Object implements Serializable

Serialized Fields

code

int code

The reason code.

domain

String domain

The domain.

domainId

int domainId

The domain ID.

textValue

String textValue

The text value.

Class com.oracle.communications.brm.cc.model.RecyclePayment

class RecyclePayment extends Extension implements Serializable

Serialized Fields

details

List<RecyclePayment.Details> details

The list of details associated with the recycled payment.

effectiveDate

Calendar effectiveDate

The date and time the recycled payment took effect.

eventRef

ResourceRef eventRef

notes

Notes notes

unallocatedSuspendedAmount

BigDecimal unallocatedSuspendedAmount

The amount of the original payment that hasn't been allocated.

Class com.oracle.communications.brm.cc.model.RecyclePayment.Details

class Details extends Object implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

billItems

List<RecyclePayment.Details.BillItems> billItems

The list of bill items associated with the recycled payment.

bills

List<RecyclePayment.Details.Bills> bills

The list of bills associated with the recycled payment.

billUnitRef

ResourceRef billUnitRef

currency

Integer currency

The currency of the original payment.

domainId

int domainId

The reason's domain ID.

reasonId

int reasonId

The reason ID for the recycled payment.

totalAmount

BigDecimal totalAmount

The total amount to be collected.

Class com.oracle.communications.brm.cc.model.RecyclePayment.Details.BillItems

class BillItems extends Object implements Serializable

Serialized Fields

amount

BigDecimal amount

The number of bill items.

itemRef

ResourceRef itemRef

Class com.oracle.communications.brm.cc.model.RecyclePayment.Details.Bills

class Bills extends Object implements Serializable

Serialized Fields

amount

BigDecimal amount

The amount due for this bill.

billNo

String billNo

The bill number.

Class com.oracle.communications.brm.cc.model.RefundableItems

class RefundableItems extends Extension implements Serializable

Serialized Fields

amount

BigDecimal amount

The amount of the refund.

arActionId

String arActionId

The ID of the A/R action associated with the refundable item.

billRef

ResourceRef billRef

billUnitName

String billUnitName

The name of the bill unit associated with the refundable item.

type

String type

The refundable item's type.

Class com.oracle.communications.brm.cc.model.RefundBills

class RefundBills extends FullRefund implements Serializable

Serialized Fields

bills

List<String> bills

The list of bills impacted by the refund.

Class com.oracle.communications.brm.cc.model.RefundDetails

class RefundDetails extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

billNo

String billNo

The bill number associated with the refund.

cycleEnds

Calendar cycleEnds

The date and time the billing cycle ends.

cycleStarts

Calendar cycleStarts

The date and time the billing cycle starts.

details

List<RefundDetails.Details> details

The list of details about the refund.

effectiveDate

Calendar effectiveDate

The date and time the refund occurred.

id

String id

The ID of the refund.

notes

Notes notes

refundAmount

BigDecimal refundAmount

The amount of the refund.

refundMethod

String refundMethod

The refund method.

refundStatus

long refundStatus

The status of the refund.

refundType

int refundType

The level of the refund. Can be one of the following:

• 1: Bill-level
• 2: Bill unit-level (/billinfo)

Class com.oracle.communications.brm.cc.model.RefundDetails.Details

class Details extends Object implements Serializable

Serialized Fields

amount

BigDecimal amount

The refund amount.

billNo

String billNo

The bill number associated with the refund.

itemName

String itemName

The name of the item associated with the refund.

itemNo

String itemNo

The item number associated with the refund.

Class com.oracle.communications.brm.cc.model.RegistrationAccount

class RegistrationAccount extends Extension implements Serializable

Serialized Fields

billUnits

List<NewBillUnits> billUnits

businessType

Integer businessType

The business type: consumer (1) or business (2).

contacts

List<Contacts> contacts

An account's contact information.

currency

int currency

The account's primary currency.

customerTypeCode

Integer customerTypeCode

The customer type: standard (1), brand (2), or subscription (3).

effective

Calendar effective

The date and time the account takes effect.

genericBundle

CustomizedBundleForPurchase genericBundle

locale

String locale

The customer's locale, such as en_US or fr_FR. For a list of valid values, see "Locale Names" in BRM Developer's Guide.

notes

Notes notes

organizationHierarchyTypeCode

Integer organizationHierarchyTypeCode

The code for the account organization hierarchy type, such as site or legal entity.

parentRef

ResourceRef parentRef

paymentMethod

List<PaymentMethod> paymentMethod

paymentType

Integer paymentType

The payment type. Can be one of the following:

• 10000:Prepaid
• 10001:Invoice
• 10003: Credit card
• 10005: Direct debit
• 10007: Subordinate

profiles

List<ProfileBase> profiles

purchasingPlanRef

String purchasingPlanRef

The resource for the purchased package, such as 0.0.0.1+-plan+45678.

securityCode1

String securityCode1

A security code used to verify account access. This provides an authentication test for customer service requests.

securityCode2

String securityCode2

A security code used to verify account access. This provides an authentication test for customer service requests.

services

List<PurchasingService> services

status

String status

The account's status: active (10100), inactive (10102), or closed (10103).

timezoneId

String timezoneId

The ID for the customer's time zone.

wallet

Wallet wallet

Class com.oracle.communications.brm.cc.model.RelativeSettings

class RelativeSettings extends Object implements Serializable

Serialized Fields

offset

int offset

The number of days, hours, minutes or so on after the cycle starts or ends.

units

String units

The offset unit. Can be one of the following:

• seconds
• minutes
• hours
• days
• months
• cycles

Class com.oracle.communications.brm.cc.model.ReplaceScenarioDetails

class ReplaceScenarioDetails extends Object implements Serializable

Serialized Fields

considerEntryDays

Integer considerEntryDays

When calculating the due date for new scenario actions, whether to ignore the new collections scenario entry days (0) or to use the new entry days (1).

notes

Notes notes

scenarioFromID

String scenarioFromID

The ID of the old collections scenario that is being replaced.

scenarioToID

String scenarioToID

The ID of the new collections scenario.

scheduleDate

Calendar scheduleDate

The date and time the new scenario actions are to be scheduled. This field is relevant only if the schedule mode is set to the user billing date. If no date is passed in and the schedule mode is user billing date, the scenario actions are scheduled for the current date.

scheduleMode

int scheduleMode

The collections scheduling mode, such as billing due date or user billing date.

Class com.oracle.communications.brm.cc.model.RequestDetails

class RequestDetails extends Extension implements Serializable

Serialized Fields

accountId

String accountId

The Account ID of the request.

contentType

String contentType

The type of content in the request.

correlationId

String correlationId

The correlation ID of the request.

descr

String descr

The description of the request.

errorInfo

List<RequestDetails.ErrorInfo> errorInfo

Information about the error.

failedInfo

RequestDetails.FailedInfo failedInfo

Failure information for the request.

headerInfo

List<RequestDetails.HeaderInfo> headerInfo

The header information for the request.

id

String id

The ID of the request.

opcodeInfo

RequestDetails.OpcodeInfo opcodeInfo

Information about the opcode related to the request.

partial

int partial

payloadStr

String payloadStr

The payload of the request.

requestInfo

RequestDetails.RequestInfo requestInfo

Information about the request.

status

int status

The status of the request.

userId

String userId

The UserID of the request.

Class com.oracle.communications.brm.cc.model.RequestDetails.ErrorInfo

class ErrorInfo extends Object implements Serializable

Serialized Fields

className

String className

The class name.

elementId

Integer elementId

The element ID.

errorCode

String errorCode

The error code.

fieldNum

Integer fieldNum

The field number.

location

String location

The location of the error.

reasonDomainId

Integer reasonDomainId

The domain ID of the reason for the error.

reasonId

Integer reasonId

The ID of the reason for the error.

Class com.oracle.communications.brm.cc.model.RequestDetails.FailedInfo

class FailedInfo extends Object implements Serializable

Serialized Fields

errorCode

String errorCode

The error code of the failure.

errorDescr

String errorDescr

The description of the error.

Class com.oracle.communications.brm.cc.model.RequestDetails.HeaderInfo

class HeaderInfo extends Object implements Serializable

Serialized Fields

name

String name

The name of the header information parameter.

value

String value

The value of the header information parameter.

Class com.oracle.communications.brm.cc.model.RequestDetails.OpcodeInfo

class OpcodeInfo extends Object implements Serializable

Serialized Fields

flags

Integer flags

The flags passed with the opcode.

opcode

int opcode

The name of the opcode.

Class com.oracle.communications.brm.cc.model.RequestDetails.RequestInfo

class RequestInfo extends Object implements Serializable

Serialized Fields

method

String method

The method of the request.

path

String path

The path of the request.

queryParam

String queryParam

The query parameters associated with the request.

url

String url

The URL of the request.

Class com.oracle.communications.brm.cc.model.Resource

class Resource extends Extension implements Serializable

Serialized Fields

reference

ResourceRef reference

Class com.oracle.communications.brm.cc.model.ResourceDetails

class ResourceDetails extends Extension implements Serializable

Serialized Fields

currencyResource

boolean currencyResource

Whether this is a currency resource (true) or not (false). The default is false.

numberOfDecimalPlaces

Integer numberOfDecimalPlaces

The number of decimal places for the resource.

resourceCode

String resourceCode

The resource's code.

resourceId

Integer resourceId

The resource's ID.

resourceName

String resourceName

The resource's name.

symbol

String symbol

The resource's symbol.

Class com.oracle.communications.brm.cc.model.ResourceGrants

class ResourceGrants extends Extension implements Serializable

Serialized Fields

deniedActions

List<String> deniedActions

grantedActions

List<String> grantedActions

resourceName

String resourceName

The name of the resource being granted.

Class com.oracle.communications.brm.cc.model.ResourceRef

class ResourceRef extends Object implements Serializable

Serialized Fields

id

String id

The ID.

uri

String uri

The Uniform Resource Identifier (URI) associated with the resource.

Class com.oracle.communications.brm.cc.model.ResponseEntity

class ResponseEntity extends Object implements Serializable

Serialized Fields

href

String href

The response href.

id

String id

The response ID.

Class com.oracle.communications.brm.cc.model.Result

class Result extends Object implements Serializable

Serialized Fields

field

String field

name

String name

reference

List<Result.Reference> reference

type

String type

Class com.oracle.communications.brm.cc.model.Result.Reference

class Reference extends Object implements Serializable

Serialized Fields

field

String field

includeInResults

Boolean includeInResults

name

String name

result

List<Result> result

Class com.oracle.communications.brm.cc.model.ReversePayment

class ReversePayment extends Extension implements Serializable

Serialized Fields

effectiveDate

Calendar effectiveDate

The date and time the payment reversal takes effect.

eventRef

ResourceRef eventRef

notes

Notes notes

Class com.oracle.communications.brm.cc.model.ReverseWriteoff

class ReverseWriteoff extends AractionBaseType implements Serializable

Class com.oracle.communications.brm.cc.model.RumMap

class RumMap extends Extension implements Serializable

Serialized Fields

netQuantity

double netQuantity

Net quantity calculated after performing the rounding.

rumName

String rumName

Specifies which RUM was used to rate this event. See /config/rum for details on rum.

unratedQuantity

double unratedQuantity

Quantity which has not been rated.

Class com.oracle.communications.brm.cc.model.SearchCriterias

class SearchCriterias extends Extension implements Serializable

Serialized Fields

criterias

List<Criterias> criterias

searchTemplateName

String searchTemplateName

Class com.oracle.communications.brm.cc.model.SearchResults

class SearchResults extends Extension implements Serializable

Serialized Fields

results

List<SearchResults.Results> results

Class com.oracle.communications.brm.cc.model.SearchResults.Results

class Results extends Object implements Serializable

Serialized Fields

column

List<SearchResults.Results.Column> column

Class com.oracle.communications.brm.cc.model.SearchResults.Results.Column

class Column extends Object implements Serializable

Serialized Fields

name

String name

value

String value

Class com.oracle.communications.brm.cc.model.SearchTemplate

class SearchTemplate extends Extension implements Serializable

Serialized Fields

defaultStepSize

Integer defaultStepSize

globalSearch

Boolean globalSearch

returnStorableClass

String returnStorableClass

searchcriterias

List<SearchTemplate.Searchcriterias> searchcriterias

searchresults

List<SearchTemplate.Searchresults> searchresults

Class com.oracle.communications.brm.cc.model.SearchTemplate.Searchcriterias

class Searchcriterias extends Object implements Serializable

Serialized Fields

criteria

List<SearchTemplate.Searchcriterias.Criteria> criteria

Class com.oracle.communications.brm.cc.model.SearchTemplate.Searchcriterias.Criteria

class Criteria extends Object implements Serializable

Serialized Fields

field

String field

joinToReturnStorableClass

String joinToReturnStorableClass

label

String label

name

String name

storableClass

String storableClass

Class com.oracle.communications.brm.cc.model.SearchTemplate.Searchresults

class Searchresults extends Object implements Serializable

Serialized Fields

result

List<Result> result

Class com.oracle.communications.brm.cc.model.SepaType

class SepaType extends PaymentInstrumentType implements Serializable

Serialized Fields

details

SepaType.Details details

The SEPA payment details.

Class com.oracle.communications.brm.cc.model.SepaType.Details

class Details extends Object implements Serializable

Serialized Fields

bankIdentifierCode

String bankIdentifierCode

The bank identifier code.

creditorId

String creditorId

The creditor's ID.

creditorName

String creditorName

The creditor's name.

debtorInfo

SepaType.Details.DebtorInfo debtorInfo

Information about the debtor.

internationalBankAccountNumber

String internationalBankAccountNumber

The international bank account number.

mandateAmended

int mandateAmended

The date and time the customer's SEPA mandate was last amended.

mandateContractDescr

String mandateContractDescr

The description of the customer's SEPA mandate contract.

mandateContractId

String mandateContractId

The ID of the customer's SEPA mandate contract.

mandateEndDate

Calendar mandateEndDate

The date and time the customer's SEPA mandate ends.

mandateLastPostedDate

Calendar mandateLastPostedDate

The date and time the customer's SEPA mandate was last posted.

mandateSignedDate

Calendar mandateSignedDate

The date and time the customer's SEPA mandate contract was signed.

mandateSignedPlace

String mandateSignedPlace

The location the customer's SEPA mandate contract was signed.

mandateStatus

int mandateStatus

The status of the customer's SEPA mandate. Can be one of the following:

• 0: Active
• 1: Expired
• 2: Canceled

mandateType

int mandateType

The mandate type. Can be one of the following:

• 0: One-off mandate
• 1: Recurring mandate

mandateUniqueReference

String mandateUniqueReference

The unique reference number for the mandate.

Class com.oracle.communications.brm.cc.model.SepaType.Details.DebtorInfo

class DebtorInfo extends Object implements Serializable

Serialized Fields

address

String address

The debtor's address.

city

String city

The debtor's city.

country

String country

The debtor's country.

identificationCode

String identificationCode

The debtor's bank identifier code.

name

String name

The debtor's name.

partyIdCode

String partyIdCode

The debtor's party ID code.

referencePartyName

String referencePartyName

The debtor's party name.

zip

String zip

The debtor's ZIP code.

Class com.oracle.communications.brm.cc.model.Service

class Service extends Extension implements Serializable

Serialized Fields

accountNumber

String accountNumber

The account number associated with the service.

discounts

List<Discount> discounts

products

List<Product> products

serviceDetails

ServiceBase serviceDetails

Class com.oracle.communications.brm.cc.model.ServiceAdminClient

class ServiceAdminClient extends ServiceAdminClientType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceAdminClientType

class ServiceAdminClientType extends ServiceBase implements Serializable

Serialized Fields

lockInfo

ServiceAdminClientType.LockInfo lockInfo

permitteds

List<ServiceAdminClientType.Permitteds> permitteds

role

List<ServiceAdminClientType.Role> role

serviceAdminclient

ServiceAdminClientType.ServiceAdminclient serviceAdminclient

Class com.oracle.communications.brm.cc.model.ServiceAdminClientType.LockInfo

class LockInfo extends Object implements Serializable

Serialized Fields

lockStatus

Integer lockStatus

loginAttempts

Integer loginAttempts

Class com.oracle.communications.brm.cc.model.ServiceAdminClientType.Permitteds

class Permitteds extends Object implements Serializable

Serialized Fields

action

String action

elem

Integer elem

maximum

BigDecimal maximum

minimum

BigDecimal minimum

type

Integer type

Class com.oracle.communications.brm.cc.model.ServiceAdminClientType.Role

class Role extends Object implements Serializable

Serialized Fields

application

String application

elem

Integer elem

profileObj

ResourceRef profileObj

Class com.oracle.communications.brm.cc.model.ServiceAdminClientType.ServiceAdminclient

class ServiceAdminclient extends Object implements Serializable

Serialized Fields

description

String description

profile

Integer profile

userPrefs

byte[] userPrefs

Class com.oracle.communications.brm.cc.model.ServiceBase

class ServiceBase extends ServiceType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceBroadband

class ServiceBroadband extends ServiceBroadbandType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceBroadbandType

class ServiceBroadbandType extends ServiceBase implements Serializable

Serialized Fields

ipAddresses

List<ServiceBroadbandType.IpAddresses> ipAddresses

serviceBroadband

ServiceBroadbandType.ServiceBroadband serviceBroadband

Class com.oracle.communications.brm.cc.model.ServiceBroadbandType.IpAddresses

class IpAddresses extends Object implements Serializable

Serialized Fields

elem

Integer elem

ipAddress

String ipAddress

Class com.oracle.communications.brm.cc.model.ServiceBroadbandType.ServiceBroadband

class ServiceBroadband extends Object implements Serializable

Serialized Fields

eventObj

ResourceRef eventObj

Class com.oracle.communications.brm.cc.model.ServiceCable

class ServiceCable extends ServiceCableType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceCableType

class ServiceCableType extends ServiceBase implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceCloud

class ServiceCloud extends ServiceCloudType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceCloudAddonStorage

class ServiceCloudAddonStorage extends ServiceCloudAddonStorageType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceCloudAddonStorageType

class ServiceCloudAddonStorageType extends ServiceCloudType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceCloudCompute

class ServiceCloudCompute extends ServiceCloudComputeType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceCloudComputeType

class ServiceCloudComputeType extends ServiceCloudType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceCloudType

class ServiceCloudType extends ServiceBase implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceConfchat

class ServiceConfchat extends ServiceConfchatType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceConfchatType

class ServiceConfchatType extends ServiceBase implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceContent

class ServiceContent extends ServiceContentType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceContentprovider

class ServiceContentprovider extends ServiceContentproviderType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceContentproviderType

class ServiceContentproviderType extends ServiceBase implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceContentType

class ServiceContentType extends ServiceBase implements Serializable

Serialized Fields

contentCategories

List<ServiceContentType.ContentCategories> contentCategories

profiles

List<ServiceContentType.Profiles> profiles

Class com.oracle.communications.brm.cc.model.ServiceContentType.ContentCategories

class ContentCategories extends Object implements Serializable

Serialized Fields

contentCategoryList

List<ServiceContentType.ContentCategories.ContentCategoryList> contentCategoryList

elem

Integer elem

mode

Integer mode

Class com.oracle.communications.brm.cc.model.ServiceContentType.ContentCategories.ContentCategoryList

class ContentCategoryList extends Object implements Serializable

Serialized Fields

contentCategoryName

String contentCategoryName

elem

Integer elem

Class com.oracle.communications.brm.cc.model.ServiceContentType.Profiles

class Profiles extends Object implements Serializable

Serialized Fields

elem

Integer elem

profileObj

ResourceRef profileObj

Class com.oracle.communications.brm.cc.model.ServiceData

class ServiceData extends ServiceDataType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceDataType

class ServiceDataType extends ServiceBase implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceDetails

class ServiceDetails extends Extension implements Serializable

Serialized Fields

friendlyName

String friendlyName

The service's friendly name.

type

String type

The service type.

Class com.oracle.communications.brm.cc.model.ServiceEmail

class ServiceEmail extends ServiceEmailType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceEmailType

class ServiceEmailType extends ServiceBase implements Serializable

Serialized Fields

aliases

List<ServiceEmailType.Aliases> aliases

attributes

List<ServiceEmailType.Attributes> attributes

serviceEmail

ServiceEmailType.ServiceEmail serviceEmail

Class com.oracle.communications.brm.cc.model.ServiceEmailType.Aliases

class Aliases extends Object implements Serializable

Serialized Fields

elem

Integer elem

name

String name

Class com.oracle.communications.brm.cc.model.ServiceEmailType.Attributes

class Attributes extends Object implements Serializable

Serialized Fields

elem

Integer elem

name

String name

value

String value

Class com.oracle.communications.brm.cc.model.ServiceEmailType.ServiceEmail

class ServiceEmail extends Object implements Serializable

Serialized Fields

mailServerId

byte[] mailServerId

maxMboxSize

Integer maxMboxSize

maxMsgCnt

Integer maxMsgCnt

maxMsgSize

Integer maxMsgSize

path

String path

Class com.oracle.communications.brm.cc.model.ServiceFax

class ServiceFax extends ServiceFaxType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceFaxType

class ServiceFaxType extends ServiceBase implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceFields

class ServiceFields extends Extension implements Serializable

Serialized Fields

fields

List<ServiceFields.Fields> fields

The list of service fields.

Class com.oracle.communications.brm.cc.model.ServiceFields.Fields

class Fields extends Object implements Serializable

Serialized Fields

attribute

String attribute

The field's attribute.

desc

String desc

The field's description.

index

int index

The position of the entry in the index. For example, the first service in a list would have an index value of 1.

label

String label

The field's label.

type

String type

The field type. Can be one of the following:

• integer
• decimal
• string
• date

Class com.oracle.communications.brm.cc.model.ServiceGroup

class ServiceGroup extends Extension implements Serializable

Serialized Fields

bundles

List<PurchasedBundle> bundles

lastStatusChange

Calendar lastStatusChange

The date and time the service's status was last modified.

serviceId

String serviceId

The service's ID.

serviceName

String serviceName

The service's name.

serviceRef

ResourceRef serviceRef

status

Integer status

The service's status.

Class com.oracle.communications.brm.cc.model.ServiceGroupIndex

class ServiceGroupIndex extends Object implements Serializable

Serialized Fields

serviceGroupElem

int serviceGroupElem

The service group element.

Class com.oracle.communications.brm.cc.model.ServiceInPlan

class ServiceInPlan extends Object implements Serializable

Serialized Fields

aliasList

List<ServiceInPlan.AliasList> aliasList

The list of aliases associated with the service.

balGrpIndex

Integer balGrpIndex

The balance group index.

bundles

List<ServiceInPlan.Bundles> bundles

The list of bundles in the service.

groupParent

Boolean groupParent

Whether this is a parent in the service group (true) or not (false).

login

String login

The login associated with the service.

serviceKey

String serviceKey

The service key.

serviceObj

ResourceRef serviceObj

serviceType

String serviceType

The service type.

status

Integer status

The status.

subscriptionIndex

Integer subscriptionIndex

The subscription index.

Class com.oracle.communications.brm.cc.model.ServiceInPlan.AliasList

class AliasList extends Object implements Serializable

Serialized Fields

elem

Integer elem

name

String name

Class com.oracle.communications.brm.cc.model.ServiceInPlan.Bundles

class Bundles extends Object implements Serializable

Serialized Fields

chargeoffers

List<ServiceInPlan.Bundles.Chargeoffers> chargeoffers

The list of charge offers in the bundle.

description

String description

The bundle's description.

discountoffers

List<ServiceInPlan.Bundles.Discountoffers> discountoffers

The list of discount offers in the bundle.

elem

Integer elem

The position of the entry in the array. For example, the first item in a list would have an elem value of 1.

name

String name

The bundle's name.

ref

ResourceRef ref

required

Boolean required

Whether the bundle is required (true) or optional (false).

Class com.oracle.communications.brm.cc.model.ServiceInPlan.Bundles.Chargeoffers

class Chargeoffers extends Object implements Serializable

Serialized Fields

baseProductCode

String baseProductCode

The code of the base product of the charge offer.

baseProductName

String baseProductName

The name of the base product of the charge offer.

baseProductRef

ResourceRef baseProductRef

description

String description

The charge offer's description.

gracePeriodOffset

Integer gracePeriodOffset

The number to offset the grace period by.

gracePeriodUnit

Integer gracePeriodUnit

The unit for the charge offer's grace period.

name

String name

The charge offer's name.

offerAttributeGroupRef

ResourceRef offerAttributeGroupRef

offerAttributes

OfferAttributes offerAttributes

ref

ResourceRef ref

renewalMode

Integer renewalMode

How to handle the charge offer's cycle alignment when its bundle is reactivated. Possible values are:

• 0: Cycle aligns with the original billing date or configured specific day of the month.
• 1: Cycle aligns with the reactivation date.

validityAlignMode

Integer validityAlignMode

This shows if the product is an addon product and alignment of validity with other products.

Class com.oracle.communications.brm.cc.model.ServiceInPlan.Bundles.Discountoffers

class Discountoffers extends Object implements Serializable

Serialized Fields

description

String description

The discount offer's description.

name

String name

The discount offer's name.

offerAttributeGroupRef

ResourceRef offerAttributeGroupRef

offerAttributes

OfferAttributes offerAttributes

ref

ResourceRef ref

Class com.oracle.communications.brm.cc.model.ServiceInstantchat

class ServiceInstantchat extends ServiceInstantchatType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceInstantchatType

class ServiceInstantchatType extends ServiceBase implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceInternettv

class ServiceInternettv extends ServiceInternettvType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceInternettvType

class ServiceInternettvType extends ServiceBase implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceIp

class ServiceIp extends ServiceIpType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceIpIptv

class ServiceIpIptv extends ServiceIpIptvType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceIpIptvType

class ServiceIpIptvType extends ServiceIpType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceIpIptvVod

class ServiceIpIptvVod extends ServiceIpIptvVodType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceIpIptvVodFilms

class ServiceIpIptvVodFilms extends ServiceIpIptvVodFilmsType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceIpIptvVodFilmsType

class ServiceIpIptvVodFilmsType extends ServiceIpIptvVodType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceIpIptvVodMovies

class ServiceIpIptvVodMovies extends ServiceIpIptvVodMoviesType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceIpIptvVodMoviesType

class ServiceIpIptvVodMoviesType extends ServiceIpIptvVodType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceIpIptvVodMv

class ServiceIpIptvVodMv extends ServiceIpIptvVodMvType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceIpIptvVodMvType

class ServiceIpIptvVodMvType extends ServiceIpIptvVodType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceIpIptvVodNews

class ServiceIpIptvVodNews extends ServiceIpIptvVodNewsType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceIpIptvVodNewsType

class ServiceIpIptvVodNewsType extends ServiceIpIptvVodType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceIpIptvVodSports

class ServiceIpIptvVodSports extends ServiceIpIptvVodSportsType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceIpIptvVodSportsType

class ServiceIpIptvVodSportsType extends ServiceIpIptvVodType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceIpIptvVodTvshows

class ServiceIpIptvVodTvshows extends ServiceIpIptvVodTvshowsType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceIpIptvVodTvshowsType

class ServiceIpIptvVodTvshowsType extends ServiceIpIptvVodType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceIpIptvVodType

class ServiceIpIptvVodType extends ServiceIpIptvType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceIpType

class ServiceIpType extends ServiceBase implements Serializable

Serialized Fields

args

List<ServiceIpType.Args> args

serviceIp

ServiceIpType.ServiceIp serviceIp

Class com.oracle.communications.brm.cc.model.ServiceIpType.Args

class Args extends Object implements Serializable

Serialized Fields

elem

Integer elem

name

String name

value

String value

Class com.oracle.communications.brm.cc.model.ServiceIpType.ServiceIp

class ServiceIp extends Object implements Serializable

Serialized Fields

compression

Integer compression

ipaddr

byte[] ipaddr

protocol

Integer protocol

Class com.oracle.communications.brm.cc.model.ServiceLdap

class ServiceLdap extends ServiceLdapType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceLdapType

class ServiceLdapType extends ServiceBase implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceMms

class ServiceMms extends ServiceMmsType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceMmsType

class ServiceMmsType extends ServiceBase implements Serializable

Class com.oracle.communications.brm.cc.model.ServicePcmClient

class ServicePcmClient extends ServicePcmClientType implements Serializable

Class com.oracle.communications.brm.cc.model.ServicePcmClientType

class ServicePcmClientType extends ServiceBase implements Serializable

Serialized Fields

lockInfo

ServicePcmClientType.LockInfo lockInfo

Class com.oracle.communications.brm.cc.model.ServicePcmClientType.LockInfo

class LockInfo extends Object implements Serializable

Serialized Fields

lockStatus

Integer lockStatus

loginAttempts

Integer loginAttempts

Class com.oracle.communications.brm.cc.model.ServiceProfile

class ServiceProfile extends Object implements Serializable

Serialized Fields

devices

List<DeviceType> devices

profile

ProfileBase profile

service

ServiceBase service

Class com.oracle.communications.brm.cc.model.ServiceProfileConfigurations

class ServiceProfileConfigurations extends Extension implements Serializable

Serialized Fields

serviceProfileDefinitions

List<ServiceProfileDefinition> serviceProfileDefinitions

Class com.oracle.communications.brm.cc.model.ServiceProfileDefinition

class ServiceProfileDefinition extends Object implements Serializable

Serialized Fields

profileFields

ProfileFields profileFields

serviceFields

ServiceFields serviceFields

serviceType

String serviceType

The service the definition is for.

Class com.oracle.communications.brm.cc.model.ServiceProvider

class ServiceProvider extends ServiceProviderType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceProviderProd

class ServiceProviderProd extends ServiceProviderProdType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceProviderProdType

class ServiceProviderProdType extends ServiceBase implements Serializable

Serialized Fields

providerProducts

List<ServiceProviderProdType.ProviderProducts> providerProducts

Class com.oracle.communications.brm.cc.model.ServiceProviderProdType.ProviderProducts

class ProviderProducts extends Object implements Serializable

Serialized Fields

elem

Integer elem

prodName

String prodName

ratePerAmount

String ratePerAmount

ratePerAmountCycle

String ratePerAmountCycle

ratePerEvent

String ratePerEvent

ratePerEventCycle

String ratePerEventCycle

Class com.oracle.communications.brm.cc.model.ServiceProviderType

class ServiceProviderType extends ServiceBase implements Serializable

Serialized Fields

providerTopics

List<ServiceProviderType.ProviderTopics> providerTopics

Class com.oracle.communications.brm.cc.model.ServiceProviderType.ProviderTopics

class ProviderTopics extends Object implements Serializable

Serialized Fields

elem

Integer elem

ratePerAmount

String ratePerAmount

ratePerEvent

String ratePerEvent

topicName

String topicName

Class com.oracle.communications.brm.cc.model.ServicePsmcontentprovider

class ServicePsmcontentprovider extends ServicePsmcontentproviderType implements Serializable

Class com.oracle.communications.brm.cc.model.ServicePsmcontentproviderType

class ServicePsmcontentproviderType extends ServiceBase implements Serializable

Class com.oracle.communications.brm.cc.model.ServicesAndBillItems

class ServicesAndBillItems extends Extension implements Serializable

Serialized Fields

accountNumber

String accountNumber

The account number associated with the service.

accountRef

ResourceRef accountRef

billItem

List<BillItem> billItem

The bill item details.

deviceID

String deviceID

The ID of the device related to the service.

firstName

String firstName

The first name of the customer owning the service.

id

String id

The ID.

lastName

String lastName

The last name of the customer owning the service.

serviceID

String serviceID

The service's ID.

serviceType

String serviceType

The service's type.

Class com.oracle.communications.brm.cc.model.ServicesByPurchase

class ServicesByPurchase extends Extension implements Serializable

Serialized Fields

count

Integer count

The number of services.

serviceType

String serviceType

The service type.

Class com.oracle.communications.brm.cc.model.ServiceSettlement

class ServiceSettlement extends ServiceSettlementType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceSettlementRoaming

class ServiceSettlementRoaming extends ServiceSettlementRoamingType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceSettlementRoamingIncollect

class ServiceSettlementRoamingIncollect extends ServiceSettlementRoamingIncollectType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceSettlementRoamingIncollectType

class ServiceSettlementRoamingIncollectType extends ServiceSettlementRoamingType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceSettlementRoamingOutcollect

class ServiceSettlementRoamingOutcollect extends ServiceSettlementRoamingOutcollectType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceSettlementRoamingOutcollectType

class ServiceSettlementRoamingOutcollectType extends ServiceSettlementRoamingType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceSettlementRoamingType

class ServiceSettlementRoamingType extends ServiceSettlementType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceSettlementType

class ServiceSettlementType extends ServiceBase implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceSpcontent

class ServiceSpcontent extends ServiceSpcontentType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceSpcontentType

class ServiceSpcontentType extends ServiceBase implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceSsg

class ServiceSsg extends ServiceSsgType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceSsgType

class ServiceSsgType extends ServiceBase implements Serializable

Serialized Fields

args

List<ServiceSsgType.Args> args

services

List<ServiceSsgType.Services> services

Class com.oracle.communications.brm.cc.model.ServiceSsgType.Args

class Args extends Object implements Serializable

Serialized Fields

elem

Integer elem

name

String name

value

String value

Class com.oracle.communications.brm.cc.model.ServiceSsgType.Services

class Services extends Object implements Serializable

Serialized Fields

elem

Integer elem

object

ResourceRef object

Class com.oracle.communications.brm.cc.model.ServiceStream

class ServiceStream extends ServiceStreamType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceStreamType

class ServiceStreamType extends ServiceBase implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelco

class ServiceTelco extends ServiceTelcoType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGprs

class ServiceTelcoGprs extends ServiceTelcoGprsType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGprsRoaming

class ServiceTelcoGprsRoaming extends ServiceTelcoGprsRoamingType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGprsRoamingType

class ServiceTelcoGprsRoamingType extends ServiceTelcoGprsType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGprsType

class ServiceTelcoGprsType extends ServiceTelcoType implements Serializable

Serialized Fields

apnArray

List<ServiceTelcoGprsType.ApnArray> apnArray

gprsInfo

ServiceTelcoGprsType.GprsInfo gprsInfo

Class com.oracle.communications.brm.cc.model.ServiceTelcoGprsType.ApnArray

class ApnArray extends Object implements Serializable

Serialized Fields

apn

String apn

elem

Integer elem

qosProfileName

String qosProfileName

Class com.oracle.communications.brm.cc.model.ServiceTelcoGprsType.GprsInfo

class GprsInfo extends Object implements Serializable

Serialized Fields

bearerService

String bearerService

cellId

String cellId

locAreaCode

String locAreaCode

routingArea

String routingArea

Class com.oracle.communications.brm.cc.model.ServiceTelcoGsm

class ServiceTelcoGsm extends ServiceTelcoGsmType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGsmData

class ServiceTelcoGsmData extends ServiceTelcoGsmDataType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGsmDataType

class ServiceTelcoGsmDataType extends ServiceTelcoGsmType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGsmFax

class ServiceTelcoGsmFax extends ServiceTelcoGsmFaxType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGsmFaxType

class ServiceTelcoGsmFaxType extends ServiceTelcoGsmType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGsmFriend

class ServiceTelcoGsmFriend extends ServiceTelcoGsmFriendType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGsmFriendType

class ServiceTelcoGsmFriendType extends ServiceTelcoGsmType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGsmMms

class ServiceTelcoGsmMms extends ServiceTelcoGsmMmsType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGsmMmsType

class ServiceTelcoGsmMmsType extends ServiceTelcoGsmType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGsmProximity

class ServiceTelcoGsmProximity extends ServiceTelcoGsmProximityType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGsmProximityType

class ServiceTelcoGsmProximityType extends ServiceTelcoGsmType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGsmRoaming

class ServiceTelcoGsmRoaming extends ServiceTelcoGsmRoamingType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGsmRoamingType

class ServiceTelcoGsmRoamingType extends ServiceTelcoGsmType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGsmSms

class ServiceTelcoGsmSms extends ServiceTelcoGsmSmsType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGsmSmsType

class ServiceTelcoGsmSmsType extends ServiceTelcoGsmType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGsmTelephony

class ServiceTelcoGsmTelephony extends ServiceTelcoGsmTelephonyType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGsmTelephonyType

class ServiceTelcoGsmTelephonyType extends ServiceTelcoGsmType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoGsmType

class ServiceTelcoGsmType extends ServiceTelcoType implements Serializable

Serialized Fields

gsmDetails

ServiceTelcoGsmType.GsmDetails gsmDetails

Class com.oracle.communications.brm.cc.model.ServiceTelcoGsmType.GsmDetails

class GsmDetails extends Object implements Serializable

Serialized Fields

bearerService

String bearerService

imei

String imei

Class com.oracle.communications.brm.cc.model.ServiceTelcoType

class ServiceTelcoType extends ServiceBase implements Serializable

Serialized Fields

telcoDetails

ServiceTelcoType.TelcoDetails telcoDetails

telcoFeatures

List<ServiceTelcoType.TelcoFeatures> telcoFeatures

Class com.oracle.communications.brm.cc.model.ServiceTelcoType.TelcoDetails

class TelcoDetails extends Object implements Serializable

Serialized Fields

primaryNumber

Integer primaryNumber

Class com.oracle.communications.brm.cc.model.ServiceTelcoType.TelcoFeatures

class TelcoFeatures extends Object implements Serializable

Serialized Fields

elem

Integer elem

name

String name

status

Integer status

Class com.oracle.communications.brm.cc.model.ServiceTelcoVoip

class ServiceTelcoVoip extends ServiceTelcoVoipType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelcoVoipType

class ServiceTelcoVoipType extends ServiceTelcoType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelephony

class ServiceTelephony extends ServiceTelephonyType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceTelephonyType

class ServiceTelephonyType extends ServiceBase implements Serializable

Serialized Fields

args

List<ServiceTelephonyType.Args> args

filterDetails

List<ServiceTelephonyType.FilterDetails> filterDetails

redirectList

List<ServiceTelephonyType.RedirectList> redirectList

serviceTelephony

ServiceTelephonyType.ServiceTelephony serviceTelephony

speedDialList

List<ServiceTelephonyType.SpeedDialList> speedDialList

Class com.oracle.communications.brm.cc.model.ServiceTelephonyType.Args

class Args extends Object implements Serializable

Serialized Fields

elem

Integer elem

name

String name

value

String value

Class com.oracle.communications.brm.cc.model.ServiceTelephonyType.FilterDetails

class FilterDetails extends Object implements Serializable

Serialized Fields

elem

Integer elem

filterList

List<ServiceTelephonyType.FilterDetails.FilterList> filterList

mode

Integer mode

Class com.oracle.communications.brm.cc.model.ServiceTelephonyType.FilterDetails.FilterList

class FilterList extends Object implements Serializable

Serialized Fields

elem

Integer elem

number

String number

Class com.oracle.communications.brm.cc.model.ServiceTelephonyType.RedirectList

class RedirectList extends Object implements Serializable

Serialized Fields

elem

Integer elem

numberIn

String numberIn

numberOut

String numberOut

Class com.oracle.communications.brm.cc.model.ServiceTelephonyType.ServiceTelephony

class ServiceTelephony extends Object implements Serializable

Serialized Fields

cos

Integer cos

maxActiveCalls

Integer maxActiveCalls

network

String network

qos

Integer qos

Class com.oracle.communications.brm.cc.model.ServiceTelephonyType.SpeedDialList

class SpeedDialList extends Object implements Serializable

Serialized Fields

elem

Integer elem

number

String number

Class com.oracle.communications.brm.cc.model.ServiceType

class ServiceType extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

aliasList

List<ServiceType.AliasList> aliasList

The list of aliases associated with the service.

balanceGroupRef

ResourceRef balanceGroupRef

balGrpIndex

Integer balGrpIndex

The balance group index.

creationDate

Calendar creationDate

The date and time the service type was created.

effectiveDate

Calendar effectiveDate

id

ResourceRef id

lastModified

Calendar lastModified

The date and time the service was last modified.

lastStatusChange

Calendar lastStatusChange

The date and time of the last status change.

lastStatusComment

String lastStatusComment

The comment associated with the last status change.

lifeCycleState

Integer lifeCycleState

The current lifecycle state.

login

String login

The login associated with the service.

name

String name

The name of the service.

nameinfoObj

ResourceRef nameinfoObj

password

String password

The password associated with the service.

passwordExpiration

Calendar passwordExpiration

The date and time the password expires.

passwordStatus

Integer passwordStatus

The current status of the password.

pendingDeferredActionsCount

Integer pendingDeferredActionsCount

The number of deferred actions that are pending for the service.

serviceAccessLevel

String serviceAccessLevel

The service access level.

status

Integer status

The status.

statusFlags

Integer statusFlags

The status flags.

subscriptionServiceRef

ResourceRef subscriptionServiceRef

svcExpLastNotiOffset

String svcExpLastNotiOffset

The notification offset.

svcExpLastNotiT

Calendar svcExpLastNotiT

The last notification time.

Class com.oracle.communications.brm.cc.model.ServiceType.AliasList

class AliasList extends Object implements Serializable

Serialized Fields

elem

Integer elem

name

String name

Class com.oracle.communications.brm.cc.model.ServiceVideochat

class ServiceVideochat extends ServiceVideochatType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceVideochatType

class ServiceVideochatType extends ServiceBase implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceVpdn

class ServiceVpdn extends ServiceVpdnType implements Serializable

Class com.oracle.communications.brm.cc.model.ServiceVpdnType

class ServiceVpdnType extends ServiceBase implements Serializable

Serialized Fields

args

List<ServiceVpdnType.Args> args

serviceIp

ServiceVpdnType.ServiceIp serviceIp

Class com.oracle.communications.brm.cc.model.ServiceVpdnType.Args

class Args extends Object implements Serializable

Serialized Fields

elem

Integer elem

name

String name

value

String value

Class com.oracle.communications.brm.cc.model.ServiceVpdnType.ServiceIp

class ServiceIp extends Object implements Serializable

Serialized Fields

compression

Integer compression

ipaddr

byte[] ipaddr

protocol

Integer protocol

Class com.oracle.communications.brm.cc.model.SettlementBill

class SettlementBill extends ARActionRequestType implements Serializable

Serialized Fields

rest

List<JAXBElement<BigDecimal>> rest

Gets the rest of the content model.

You are getting this "catch-all" property because of the following reason: The field name "Percent" is used by two different parts of a schema. See: line 48 of file:/D:/BillingCare_code/Hierarchy_automation/billingcare/customercare/schemafiles/classes/schema/disputeAndSettlement.xsd line 42 of file:/D:/BillingCare_code/Hierarchy_automation/billingcare/customercare/schemafiles/classes/schema/adjustment.xsd

To get rid of this property, apply a property customization to one of both of the following declarations to change their names:

Class com.oracle.communications.brm.cc.model.SettlementDetails

class SettlementDetails extends Extension implements Serializable

Serialized Fields

billId

String billId

The ID of the bill associated with the settlement.

billingEnd

Calendar billingEnd

The date and time the billing cycle ends.

billingStart

Calendar billingStart

The date and time the billing cycle starts.

billNumber

String billNumber

The bill number associated with the settlement.

disputedAmount

BigDecimal disputedAmount

The amount of the dispute.

disputedDate

Calendar disputedDate

The date and time the bill, item, or event was disputed.

disputeId

String disputeId

The ID of the dispute.

disputeRef

ResourceRef disputeRef

due

BigDecimal due

The amount due after the settlement.

effectiveDate

Calendar effectiveDate

The date and time the dispute takes effect.

eventsCount

String eventsCount

The number of events associated with the settlement.

itemId

String itemId

The ID of the item associated with the settlement.

itemName

String itemName

The name of the item associated with the settlement.

itemNumber

String itemNumber

The item number associated with the settlement.

notes

Notes notes

settledDate

Calendar settledDate

The date and time the dispute was settled.

settledNonTaxedAmount

BigDecimal settledNonTaxedAmount

The non-taxable amount for the bill item settled by the adjustment.

settledTaxAmount

BigDecimal settledTaxAmount

The amount of tax for the bill item settled by the adjustment.

settledTaxedAmount

BigDecimal settledTaxedAmount

The taxable amount for the bill item settled by the adjustment.

settlementAmount

BigDecimal settlementAmount

The settlement amount. The amount you enter can be all, a portion, or none of the disputed amount.

settlementId

String settlementId

The ID of the settlement.

settlementRef

ResourceRef settlementRef

Class com.oracle.communications.brm.cc.model.SettlementEvent

class SettlementEvent extends EventARAction implements Serializable

Class com.oracle.communications.brm.cc.model.SettlementItem

class SettlementItem extends ARActionRequestType implements Serializable

Serialized Fields

rest

List<JAXBElement<BigDecimal>> rest

Gets the rest of the content model.

You are getting this "catch-all" property because of the following reason: The field name "Percent" is used by two different parts of a schema. See: line 67 of file:/D:/BillingCare_code/Hierarchy_automation/billingcare/customercare/schemafiles/classes/schema/disputeAndSettlement.xsd line 42 of file:/D:/BillingCare_code/Hierarchy_automation/billingcare/customercare/schemafiles/classes/schema/adjustment.xsd

To get rid of this property, apply a property customization to one of both of the following declarations to change their names:

Class com.oracle.communications.brm.cc.model.SharingGroupMembers

class SharingGroupMembers extends Extension implements Serializable

Serialized Fields

groupType

String groupType

The sharing group type. Allowed Values:

• H_PSG (Hierarchy product sharing group)
• PR_PSG (Payment responsibility product sharing group)
• H_DSG (Hierarchy discount sharing group)
• PR_DSG (Payment responsibility discount sharing group)

memberDetails

List<SharingGroupMembers.MemberDetails> memberDetails

The list of sharing group members.

Class com.oracle.communications.brm.cc.model.SharingGroupMembers.MemberDetails

class MemberDetails extends Object implements Serializable

Serialized Fields

accountNumber

String accountNumber

The member's account number.

accountRef

ResourceRef accountRef

firstName

String firstName

The member's first name.

lastName

String lastName

The member's last name.

memberIndex

int memberIndex

Index of the non-service charges being a member of the group.

services

List<SharingGroupMembers.MemberDetails.Services> services

The list of services shared in the group.

Class com.oracle.communications.brm.cc.model.SharingGroupMembers.MemberDetails.Services

class Services extends Object implements Serializable

Serialized Fields

aliasList

List<SharingGroupMembers.MemberDetails.Services.AliasList> aliasList

The list of aliases associated with the service.

index

Integer index

The position of the entry in the index. For example, the first service in a list would have an index value of 1.

login

String login

The login associated with the service.

serviceRef

ResourceRef serviceRef

serviceType

String serviceType

The service type of the service member.

Class com.oracle.communications.brm.cc.model.SharingGroupMembers.MemberDetails.Services.AliasList

class AliasList extends Object implements Serializable

Serialized Fields

elem

Integer elem

name

String name

Class com.oracle.communications.brm.cc.model.SharingMember

class SharingMember extends Extension implements Serializable

Serialized Fields

membership

List<SharingMember.Membership> membership

The list of sharing groups that the member belongs to.

orderedBalGroupRef

ResourceRef orderedBalGroupRef

Class com.oracle.communications.brm.cc.model.SharingMember.Membership

class Membership extends Object implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

groupRef

ResourceRef groupRef

serviceRef

ResourceRef serviceRef

Class com.oracle.communications.brm.cc.model.SharingMemberDetails

class SharingMemberDetails extends Extension implements Serializable

Serialized Fields

groupref

ResourceRef groupref

membershipDetails

List<SharingMemberDetails.MembershipDetails> membershipDetails

The list of groups the member belongs to.

orderedBalGroupref

ResourceRef orderedBalGroupref

serviceRef

ResourceRef serviceRef

Class com.oracle.communications.brm.cc.model.SharingMemberDetails.MembershipDetails

class MembershipDetails extends Object implements Serializable

Serialized Fields

accountNumber

String accountNumber

The account number associated with the sharing group.

accountRef

ResourceRef accountRef

groupName

String groupName

The sharing group's name.

groupRef

ResourceRef groupRef

groupType

String groupType

The sharing group type. Allowed Values:

• H_PSG (Hierarchy product sharing group)
• PR_PSG (Payment responsibility product sharing group)
• H_DSG (Hierarchy discount sharing group)
• PR_DSG (Payment responsibility discount sharing group)

parentName

String parentName

The sharing group parent's name.

priority

int priority

The priority.

serviceName

String serviceName

The name of the service being shared.

serviceRef

ResourceRef serviceRef

Class com.oracle.communications.brm.cc.model.SharingMemberServiceDetails

class SharingMemberServiceDetails extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

members

List<SharingMemberServiceDetails.Members> members

The list of members in the sharing group.

Class com.oracle.communications.brm.cc.model.SharingMemberServiceDetails.Members

class Members extends Object implements Serializable

Serialized Fields

index

Integer index

The position of the service in the index. For example, the first item in a list would have an index value of 1.

markAsDelete

Boolean markAsDelete

Whether the service referenced is being deleted (true) or added (false) to the sharing group.

serviceRef

ResourceRef serviceRef

Class com.oracle.communications.brm.cc.model.SharingOwner

class SharingOwner extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

groupName

String groupName

The name of the sharing group.

groupOwnerBalGroupref

ResourceRef groupOwnerBalGroupref

ownership

List<SharingOwner.Ownership> ownership

The list of owners for the sharing group.

parentRef

ResourceRef parentRef

rollup

boolean rollup

Whether impacts to the sharing group owner account for shared charges/discounts will be deferred (true) or not, meaning impacts to the sharing group owner occur in the same transaction (false).

Class com.oracle.communications.brm.cc.model.SharingOwner.Ownership

class Ownership extends Object implements Serializable

Serialized Fields

index

int index

The position of the entry in the index. For example, the first item in a list would have an index value of 1.

markAsDelete

boolean markAsDelete

Whether to delete the ownership (true) or not (false).

offeringRef

ResourceRef offeringRef

sharingRef

ResourceRef sharingRef

Class com.oracle.communications.brm.cc.model.SharingOwnerDetails

class SharingOwnerDetails extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

billunitName

String billunitName

The name of the bill unit associated with the sharing group.

globalChargeShareGroup

boolean globalChargeShareGroup

Whether this is a global charge sharing group (true) or not (false).

groupName

String groupName

The name of the sharing group.

groupOwnerBalGroupName

String groupOwnerBalGroupName

The name of the balance group owner.

groupOwnerBalGroupref

ResourceRef groupOwnerBalGroupref

groupRef

ResourceRef groupRef

groupType

String groupType

The sharing group type. Allowed Values:

• H_PSG (Hierarchy product sharing group)
• PR_PSG (Payment responsibility product sharing group)
• H_DSG (Hierarchy discount sharing group)
• PR_DSG (Payment responsibility discount sharing group)

memberCount

int memberCount

The number of members in the sharing group.

ownershipDetails

List<SharingOwnerDetails.OwnershipDetails> ownershipDetails

The ownership details for the sharing group.

parentName

String parentName

The parent's name.

parentRef

ResourceRef parentRef

paymentMethod

String paymentMethod

The payment method associated with the sharing group.

rollupEnabledSharingGroup

boolean rollupEnabledSharingGroup

Whether rollup is enabled for the charge sharing group (true) or not (false).

Class com.oracle.communications.brm.cc.model.SharingOwnerDetails.OwnershipDetails

class OwnershipDetails extends Object implements Serializable

Serialized Fields

description

String description

The sharing group description.

index

int index

The position of the entry in the index. For example, the first item in a list would have an (index) value of (1).

name

String name

The sharing group name.

offeringRef

ResourceRef offeringRef

quantity

BigDecimal quantity

The quantity.

sharingRef

ResourceRef sharingRef

validFrom

Calendar validFrom

The date and time the sharing group's validity starts.

validTo

Calendar validTo

The date and time the sharing group's validity ends.

Class com.oracle.communications.brm.cc.model.Sponsor

class Sponsor extends Extension implements Serializable

Serialized Fields

description

String description

The sponsored offer's description.

eventDescription

String eventDescription

The description of the event associated with the sponsored offer.

eventType

String eventType

The event type associated with the sponsored offer.

name

String name

The name of the sharing group.

offeringRef

ResourceRef offeringRef

quantity

String quantity

The quantity of the sponsored offer in the sharing group.

rollupEnabledSponsor

boolean rollupEnabledSponsor

Whether this is a rollup-enabled sponsor (true) or not (false).

selected

boolean selected

Whether the sponsored offer is selected (true) or not (false).

sponsorshipRef

ResourceRef sponsorshipRef

validFrom

Calendar validFrom

The date and time the sponsored offer's validity starts.

validTo

Calendar validTo

The date and time the sponsored offer's validity ends.

Class com.oracle.communications.brm.cc.model.StartingType

class StartingType extends Object implements Serializable

Serialized Fields

mode

String mode

The starting type mode for a product. Can be one of the following:

• immediately: The start date is set to today. This mode can be used with the purchaseStart, cycleStart, and usageStart parameters.
• absolute: The start date is a calendar date. This mode can be used with the purchaseStart, cycleStart, and usageStart parameters.
• relativeToPurchase: The start date is relative to the purchase date, such as a specified number of billing cycles, months, days, hours, minutes, or seconds after activation. This mode can be used with the cycleStart and usageStart parameters.
• firstUsage: The start day is the day of the first recorded usage.

startDate

Calendar startDate

The date and time the cycle starts.

unitSettings

RelativeSettings unitSettings

Class com.oracle.communications.brm.cc.model.State

class State extends Extension implements Serializable

Serialized Fields

allowedTransitionStates

List<Integer> allowedTransitionStates

The list of states that a resource can transition to.

stateId

int stateId

The ID of the state.

stateName

String stateName

The name of the state.

Class com.oracle.communications.brm.cc.model.Status

class Status extends Extension implements Serializable

Serialized Fields

effective

Calendar effective

The date and time the status takes effect.

effectiveWhen

String effectiveWhen

When the status takes effect. Can be one of the following:

• 1: Immediately
• 2: Backdated
• 3: Future-dated

lifeCycleStateEnabled

boolean lifeCycleStateEnabled

Whether the lifecycle state is enabled (true) or not (false).

notes

Notes notes

statusCode

int statusCode

The status code. Can be one of the following:

• 10100: Active
• 10102: Inactive
• 10103: Closed

Class com.oracle.communications.brm.cc.model.StorableClassMap

class StorableClassMap extends Object implements Serializable

Serialized Fields

mapping

List<Mapping> mapping

Class com.oracle.communications.brm.cc.model.SubBalanceImpact

class SubBalanceImpact extends Extension implements Serializable

Serialized Fields

availableLoanBalance

double availableLoanBalance

This field represents the loan balance available for this resource

balanceGroupObj

ResourceRef balanceGroupObj

The balance group object these sub balance impact belongs to.

currentBal

double currentBal

This field represents the total available main balance for this resource.

resourceId

int resourceId

Numeric value of the resource that is impacted.

subBalances

List<EventSubBalances> subBalances

Array to hold the sub_balances impacts.

Class com.oracle.communications.brm.cc.model.SubBalances

class SubBalances extends Extension implements Serializable

Serialized Fields

currentBalance

BigDecimal currentBalance

The current amount of the sub-balance.

elementId

Integer elementId

The ID of the element.

expiredBeforeUsing

BigDecimal expiredBeforeUsing

The number of days until the sub-balance expires.

grantorObj

ResourceRef grantorObj

The grantor object of the sub-balance.

originalBalance

BigDecimal originalBalance

The original balance of the sub-balance.

rolloverData

Integer rolloverData

Indicates whether the leftover balance in this bucket will be rolled over, and if so, how.

validFrom

Calendar validFrom

The date and time the validity period starts.

validTo

Calendar validTo

The date and time the validity period ends.

Class com.oracle.communications.brm.cc.model.SubscriptionPreviewCancellationCharges

class SubscriptionPreviewCancellationCharges extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

contractPreviewCancellationCharges

List<ContractPreviewCancellationCharge> contractPreviewCancellationCharges

currency

int currency

The currency associated with the cancelation fee.

scopeLevel

int scopeLevel

The level of the cancelation. Can be one of the following:

• 1: Account level
• 2: Package level
• 3: Bundle level

totalCancellationFee

BigDecimal totalCancellationFee

The total cancelation fee.

Class com.oracle.communications.brm.cc.model.SubscriptionTerms

class SubscriptionTerms extends Extension implements Serializable

Serialized Fields

accountRef

ResourceRef accountRef

autoRenew

boolean autoRenew

Whether to automatically renew the terms at the end of its commitment period (true) or not (false).

bundleName

String bundleName

The name of the bundle associated with the subscription terms.

bundleRef

ResourceRef bundleRef

commitmentEndDate

Calendar commitmentEndDate

The date and time the commitment period ends.

commitmentPeriod

int commitmentPeriod

The duration of the commitment period.

commitmentStartDate

Calendar commitmentStartDate

The date and time the commitment period starts.

commitmentUnit

int commitmentUnit

The unit for the commitment period. Can be one of the following:

• 0: Months
• 1: Days

currency

int currency

The currency associated with the subscription fee.

earlyCancellationAllowed

boolean earlyCancellationAllowed

Whether early cancellation is allowed (true) or not (false).

earlyCancellationDate

Calendar earlyCancellationDate

The date and time of early cancellation.

earlyCancellationFee

BigDecimal earlyCancellationFee

The fee for canceling a subscription early.

earlyCancellationType

int earlyCancellationType

The type of early cancelation fee. Can be one of the following:

• 0: Fixed
• 1: Reducing

gracePeriod

int gracePeriod

The duration of the grace period.

gracePeriodUnit

int gracePeriodUnit

The unit for the grace period. Can be one of the following:

• 0: Months
• 1: Days

id

String id

The ID.

minimumCommitmentPeriod

int minimumCommitmentPeriod

The duration of the minimum commitment period.

minimumCommitmentUnit

int minimumCommitmentUnit

The unit for the minimum commitment period. Can be one of the following:

• 0: Months
• 1: Years

minimumContractEndDate

Calendar minimumContractEndDate

The minimum date and time the contract is in effect before termination.

originalCommitmentEndDate

Calendar originalCommitmentEndDate

The date and time the original commitment period ends.

packageId

Integer packageId

The ID of package associated with the subscription terms.

packageRef

ResourceRef packageRef

previousContracts

List<SubscriptionTerms> previousContracts

Stores contracts previously linked to the current contract.

reducedCancellationFee

BigDecimal reducedCancellationFee

The reduced cancellation fee.

renewalContractTerms

SubscriptionTerms renewalContractTerms

renewWithSameTerms

boolean renewWithSameTerms

Whether to renew with the same terms (true) or with different terms (false).

serviceRef

ResourceRef serviceRef

status

int status

The status of the contract.

subscriberContractRef

ResourceRef subscriberContractRef

termsDescription

String termsDescription

The subscription terms' description.

termsName

String termsName

The subscription terms' name.

Class com.oracle.communications.brm.cc.model.SuspenseAccount

class SuspenseAccount extends Extension implements Serializable

Serialized Fields

accountId

String accountId

The ID of the account.

accountNumber

String accountNumber

The account number.

firstName

String firstName

The first name of the suspense account..

lastName

String lastName

The last name of the suspense account.

Class com.oracle.communications.brm.cc.model.TaxInfo

class TaxInfo extends Extension implements Serializable

Serialized Fields

businessAccount

Boolean businessAccount

Whether this is a business account (true) or not (false).

insideIncorporatedArea

Boolean insideIncorporatedArea

Whether the customer is located inside the incorporated area of a city (true) or not (false).

notes

Notes notes

taxExemptDetails

List<TaxInfo.TaxExemptDetails> taxExemptDetails

The details associated with a tax exemption.

Class com.oracle.communications.brm.cc.model.TaxInfo.TaxExemptDetails

class TaxExemptDetails extends Object implements Serializable

Serialized Fields

certificateNumber

String certificateNumber

The tax exemption certificate number.

ends

Calendar ends

The date and time the tax exemption ends.

percent

BigDecimal percent

The percentage of the tax that is exempt, such as 50 or 100.

starts

Calendar starts

The date and time the tax exemption starts.

taxType

int taxType

The exemption jurisdiction type. Can be one of the following:

• 0: Federal
• 1: State
• 2: County
• 3: City
• 4: Secondary county
• 5: Secondary city
• 6: Territory
• 7: Secondary state
• 8: District
• 9: Secondary federal
• 10: County district
• 11: City district
• 12: Other

Class com.oracle.communications.brm.cc.model.TaxJurisdiction

class TaxJurisdiction extends Extension implements Serializable

Serialized Fields

amount

double amount

This is the actual tax that is levied for this jurisdiction.

amountExempt

double amountExempt

Amount exempted from taxes.

amountGross

double amountGross

Gross amount. Taxable after deducting exemptions.

amountTaxed

double amountTaxed

Amount eligible for taxing. Same as gross less exemption unless when applying taxes on amounts that have been taxed already for a different jurisdiction.

elementId

int elementId

Balance impact array element-id match.

name

String name

The name of the jurisdiction. Includes jurisdiction names from top level upto this jurisdiction with semicolon separated pieces.

percent

double percent

Tax percent for the jurisdiction type.

type

int type

Jurisdiction type.

Class com.oracle.communications.brm.cc.model.TempCreditLimit

class TempCreditLimit extends Extension implements Serializable

Serialized Fields

limit

BigDecimal limit

The temporary credit limit amount.

resourceId

Integer resourceId

The resource ID associated with the temporary credit limit.

validFrom

Calendar validFrom

The date and time temporary credit limit's validity starts.

validFromOffset

Integer validFromOffset

The offset for the temporary credit limit's validity period start.

validFromUnit

Integer validFromUnit

The unit for the temporary credit limit's validity period start.

validTo

Calendar validTo

The date and time temporary credit limit's validity ends.

validToOffset

Integer validToOffset

The offset for the temporary credit limit's validity period end.

validToUnit

Integer validToUnit

The unit for the temporary credit limit's validity period end.

Class com.oracle.communications.brm.cc.model.TemplateFields

class TemplateFields extends Object implements Serializable

Serialized Fields

batchName

String batchName

The batch name, for example Cash Payment Batch or Check Payment Batch.

batchTemplateRef

ResourceRef batchTemplateRef

batchType

int batchType

The type of the batch. Allowed values: 1 (payment), 2 (refund), or 3 (reversal).

columnLink

List<TemplateFields.ColumnLink> columnLink

Indicates the order of the columns present in the batch.

consecutive

int consecutive

Whether to treat consecutive delimiters as one (true) or not (false).

delimiter

String delimiter

The delimiter that is used to separate fields.

footerEndRow

int footerEndRow

The row at which the footer ends.

footerStartRow

int footerStartRow

The row from which the footer starts.

headerEndRow

int headerEndRow

The row at which the header ends.

headerStartRow

int headerStartRow

The row from which the header starts.

payType

int payType

The payment method type. Allowed values:

• 10003 (Credit card)
• 10005 (Direct debit)
• 10011 (Cash)
• 10012 (Check)
• 10013 (Wire Transfer)
• 10014 (Inter-bank payment order)
• 10015 (Postal order)
• Any customized payment methods that have been added for your implementation

qualifier

String qualifier

Ignore delimiters between specific characters. Valid characters are ", ', or none.

startRow

int startRow

The row from which import should start.

Class com.oracle.communications.brm.cc.model.TemplateFields.ColumnLink

class ColumnLink extends Object implements Serializable

Serialized Fields

fieldName

String fieldName

The name of the column.

index

int index

The position in which the column appears.

purpose

int purpose

Whether the field is specific to the batch (1) or not (0).

Class com.oracle.communications.brm.cc.model.TimePeriod

class TimePeriod extends Object implements Serializable

Serialized Fields

endDateTime

String endDateTime

startDateTime

String startDateTime

Class com.oracle.communications.brm.cc.model.TransferBalance

class TransferBalance extends Extension implements Serializable

Serialized Fields

chargeDestination

Boolean chargeDestination

The destination for a charge.

chargeSource

Boolean chargeSource

The source for a charge.

description

String description

The transfer's description.

sourceLocation

LocationDetails sourceLocation

sourceRef

TransferBalance.SourceRef sourceRef

The balance transfer's source.

targetLocation

LocationDetails targetLocation

targetRef

TransferBalance.TargetRef targetRef

The balance transfer's target.

transferAmount

BigDecimal transferAmount

The transfer amount.

transferAmountType

int transferAmountType

The transfer amount's type.

validFrom

Calendar validFrom

The date and time the transfer's validity starts.

validTo

Calendar validTo

The date and time the transfer's validity ends.

Class com.oracle.communications.brm.cc.model.TransferBalance.SourceRef

class SourceRef extends Object implements Serializable

Serialized Fields

id

String id

The source's ID.

type

String type

The source's type. Can be one of the following:

• balanceGroup
• account
• service

Class com.oracle.communications.brm.cc.model.TransferBalance.TargetRef

class TargetRef extends Object implements Serializable

Serialized Fields

id

String id

The target's ID.

type

String type

The target's type. Can be one of the following:

• balanceGroup
• account
• service

Class com.oracle.communications.brm.cc.model.TransferBalanceCreateResponse

class TransferBalanceCreateResponse extends Extension implements Serializable

Serialized Fields

id

String id

The response's ID.

sourceBucket

List<TransferBalanceCreateResponse.SourceBucket> sourceBucket

The bucket at the source.

sourceRef

TransferBalanceCreateResponse.SourceRef sourceRef

The transfer's source.

sourceTransferFee

TransferBalanceCreateResponse.SourceTransferFee sourceTransferFee

The transfer fee charged to the source.

targetBucket

List<TransferBalanceCreateResponse.TargetBucket> targetBucket

The bucket at the target.

targetRef

TransferBalanceCreateResponse.TargetRef targetRef

The transfer's target.

targetTransferFee

TransferBalanceCreateResponse.TargetTransferFee targetTransferFee

The transfer fee charged to the target.

transferAmount

BigDecimal transferAmount

The transfer amount.

transferAmountType

int transferAmountType

The transfer amount's type.

uri

String uri

The response's URI.

Class com.oracle.communications.brm.cc.model.TransferBalanceCreateResponse.SourceBucket

class SourceBucket extends Object implements Serializable

Serialized Fields

currentBalance

BigDecimal currentBalance

The current balance in the bucket.

validFrom

Calendar validFrom

The date and time the bucket's validity starts.

validTo

Calendar validTo

The date and time the bucket's validity ends.

Class com.oracle.communications.brm.cc.model.TransferBalanceCreateResponse.SourceRef

class SourceRef extends Object implements Serializable

Serialized Fields

id

String id

The source's ID.

type

String type

The source's type. Can be one of the following:

• balanceGroup
• account
• service

Class com.oracle.communications.brm.cc.model.TransferBalanceCreateResponse.SourceTransferFee

class SourceTransferFee extends Object implements Serializable

Serialized Fields

amount

BigDecimal amount

The amount of the fee.

feeTax

BigDecimal feeTax

The tax on the fee.

resourceId

Integer resourceId

The ID of the resource associated with the fee.

Class com.oracle.communications.brm.cc.model.TransferBalanceCreateResponse.TargetBucket

class TargetBucket extends Object implements Serializable

Serialized Fields

currentBalance

BigDecimal currentBalance

The current balance in the bucket.

validFrom

Calendar validFrom

The date and time the bucket's validity starts.

validTo

Calendar validTo

The date and time the bucket's validity ends.

Class com.oracle.communications.brm.cc.model.TransferBalanceCreateResponse.TargetRef

class TargetRef extends Object implements Serializable

Serialized Fields

id

String id

The target's ID.

type

String type

The target's type. Can be one of the following:

• balanceGroup
• account
• service

Class com.oracle.communications.brm.cc.model.TransferBalanceCreateResponse.TargetTransferFee

class TargetTransferFee extends Object implements Serializable

Serialized Fields

amount

BigDecimal amount

The amount of the fee.

feeTax

BigDecimal feeTax

The tax on the fee.

resourceId

Integer resourceId

The ID of the resource associated with the fee.

Class com.oracle.communications.brm.cc.model.TransferBalanceDetails

class TransferBalanceDetails extends Extension implements Serializable

Serialized Fields

chargeDestination

Boolean chargeDestination

The destination for a charge.

chargeSource

Boolean chargeSource

The source for a charge.

id

String id

The transfer's ID.

sourceAccountRef

ResourceRef sourceAccountRef

sourceImpactedBucket

List<TransferBalanceDetails.SourceImpactedBucket> sourceImpactedBucket

The impacted bucket at the source.

sourceRef

TransferBalanceDetails.SourceRef sourceRef

The transfer's source.

sourceTransferFee

TransferBalanceDetails.SourceTransferFee sourceTransferFee

The transfer fee to charge the source.

targetAccountRef

ResourceRef targetAccountRef

targetImpactedBucket

List<TransferBalanceDetails.TargetImpactedBucket> targetImpactedBucket

targetRef

TransferBalanceDetails.TargetRef targetRef

The transfer's target.

targetTransferFee

TransferBalanceDetails.TargetTransferFee targetTransferFee

The transfer fee to charge the target.

transferAmount

BigDecimal transferAmount

The transfer amount.

transferAmountType

int transferAmountType

The transfer amount's type.

transferDate

Calendar transferDate

The date and time of the transfer.

Class com.oracle.communications.brm.cc.model.TransferBalanceDetails.SourceImpactedBucket

class SourceImpactedBucket extends Object implements Serializable

Serialized Fields

amount

BigDecimal amount

The amount in the bucket.

validFrom

Calendar validFrom

The date and time the bucket's validity starts.

validTo

Calendar validTo

The date and time the bucket's validity ends.

Class com.oracle.communications.brm.cc.model.TransferBalanceDetails.SourceRef

class SourceRef extends Object implements Serializable

Serialized Fields

id

String id

The source's ID.

type

String type

The source's type. Can be one of the following:

• balanceGroup
• account
• service

Class com.oracle.communications.brm.cc.model.TransferBalanceDetails.SourceTransferFee

class SourceTransferFee extends Object implements Serializable

Serialized Fields

amount

BigDecimal amount

The amount of the fee.

feeTax

BigDecimal feeTax

The tax on the fee.

resourceId

Integer resourceId

The ID of the resource associated with the fee.

Class com.oracle.communications.brm.cc.model.TransferBalanceDetails.TargetImpactedBucket

class TargetImpactedBucket extends Object implements Serializable

Serialized Fields

amount

BigDecimal amount

The amount in the bucket.

validFrom

Calendar validFrom

The date and time the bucket's validity starts.

validTo

Calendar validTo

The date and time the bucket's validity ends.

Class com.oracle.communications.brm.cc.model.TransferBalanceDetails.TargetRef

class TargetRef extends Object implements Serializable

Serialized Fields

id

String id

The target's ID.

type

String type

The target's type. Can be one of the following:

• balanceGroup
• account
• service

Class com.oracle.communications.brm.cc.model.TransferBalanceDetails.TargetTransferFee

class TargetTransferFee extends Object implements Serializable

Serialized Fields

amount

BigDecimal amount

The amount of the fee.

feeTax

BigDecimal feeTax

The tax on the fee.

resourceId

Integer resourceId

The ID of the resource associated with the fee.

Class com.oracle.communications.brm.cc.model.TransitionPath

class TransitionPath extends Object implements Serializable

Serialized Fields

fromRef

ResourceRef fromRef

Reference to the subscriber's current package/bundle that is eligible for transition.

toRef

ResourceRef toRef

Reference to a target package/bundle that BRM permits transitioning to from the specified source based on configured transition rules.

transitionOn

String transitionOn

BRM service type on which transition will take place. For example, '/service/ip', '/service/telco/gsm/telephony'.

type

int type

Type of the transition as configured /config/transition_type in BRM. For example, 1 (upgrade), 2 (downgrade), 3 (generation change), etc.

Class com.oracle.communications.brm.cc.model.TransitionPaths

class TransitionPaths extends Extension implements Serializable

Serialized Fields

_package

List<Package> _package

A package.

bundle

List<Bundle> bundle

A bundle.

path

List<TransitionPath> path

Class com.oracle.communications.brm.cc.model.UpdateServiceAndEras

class UpdateServiceAndEras extends Object implements Serializable

Serialized Fields

profiles

List<ProfileBase> profiles

service

ServiceBase service

Class com.oracle.communications.brm.cc.model.UpdateServiceProfile

class UpdateServiceProfile extends Object implements Serializable

Serialized Fields

devices

List<UpdateServiceProfile.Devices> devices

The list of devices associated with the service profile.

profile

ProfileBase profile

service

ServiceBase service

Class com.oracle.communications.brm.cc.model.UpdateServiceProfile.Devices

class Devices extends Object implements Serializable

Serialized Fields

associateDevice

boolean associateDevice

Whether to associate the device with the profile (true) or disassociate it (false).

description

String description

The device's description.

id

String id

The device ID.

Class com.oracle.communications.brm.cc.model.User

class User extends Extension implements Serializable

Serialized Fields

userName

String userName

The user name.

Class com.oracle.communications.brm.cc.model.Wallet

class Wallet extends Extension implements Serializable

Serialized Fields

paymentInstrument

List<JAXBElement<? extends PaymentInstrumentType>> paymentInstrument

Class com.oracle.communications.brm.cc.model.WithdrawPayment

class WithdrawPayment extends Extension implements Serializable

Serialized Fields

domainId

int domainId

The reason's domain ID.

effectiveDate

Calendar effectiveDate

The date and time the payment withdrawal took effect.

notes

Notes notes

paymentEventRef

ResourceRef paymentEventRef

reasonId

int reasonId

The reason ID for the payment withdrawal.

suspenseAccountId

String suspenseAccountId

The ID of the suspended account associated with the withdrawal.

Class com.oracle.communications.brm.cc.model.Writeoff

class Writeoff extends AbstractARActionType implements Serializable

Serialized Fields

actionAffectsRef

ResourceRef actionAffectsRef

effective

Calendar effective

The date and time the write-off takes effect.

inactivateAccount

boolean inactivateAccount

Whether to inactivate the account (true) or not (false). The default is false.

notes

Notes notes

writeoffTax

boolean writeoffTax

Whether to write off the tax amount (true) or not (false). The default is true.

Class com.oracle.communications.brm.cc.model.WriteOffDetails

class WriteOffDetails extends AbstractARActionType implements Serializable

Serialized Fields

accountNumber

String accountNumber

The account number associated with the write-off.

actionAffectsRef

ResourceRef actionAffectsRef

billNumber

String billNumber

The bill number associated with the write-off.

billUnitName

String billUnitName

The name of the bill unit associated with the write-off.

cycleEnds

Calendar cycleEnds

The date and time the cycle ends.

cycleStarts

Calendar cycleStarts

The date and time the cycle starts.

effectiveDate

Calendar effectiveDate

The date and time the write-off takes effect.

itemName

String itemName

The name of the item associated with the write-off.

itemNumber

String itemNumber

The item number associated with the write-off.

notes

List<Notes> notes

reversalAmount

BigDecimal reversalAmount

The amount of the write-off reversal.

reversalEffectiveDate

Calendar reversalEffectiveDate

The date and time the write-off reversal takes effect.

reversalId

String reversalId

The ID of the write-off reversal.

reversalRef

ResourceRef reversalRef

writeoffAmount

BigDecimal writeoffAmount

The amount to write off.

writeoffID

String writeoffID

The write-off's ID.

writeoffRef

ResourceRef writeoffRef

writeoffType

long writeoffType

The type of write-off.

Package com.oracle.communications.brm.cc.util

Class com.oracle.communications.brm.cc.util.LogoutServlet

class LogoutServlet extends HttpServlet implements Serializable

Package com.oracle.communications.brm.cc.validation.exception

Exception Class com.oracle.communications.brm.cc.validation.exception.ValidationException

class ValidationException extends WebApplicationException implements Serializable