1. Patch Set Release Notes
  2. Storable Class Changes

8 Storable Class Changes

The Oracle Communications Billing and Revenue Management (BRM) 12.0 Patch Sets include new and modified storable classes.

Topics in this document:

New Storable Classes

Table 8-1 lists the storable classes that have been introduced in the BRM 12.0 patch set releases.

Table 8-1 New Storable Classes

New Storable Class Description

/config/collections/promise_to_pay_spec

(Patch Set 7) Store details about a promise-to-pay specification for bills that are in collections. It lists the minimum installment amount, the number of days between installment payments, and so on.

/config/stored_procedure

(Patch Set 7) Stores information about all stored procedures that can be run by client applications connected to the CM. The object contains information about stored procedures included with BRM, but you can add custom stored procedures.

/event/group/sharing/products

(Patch Set 7) Stores information about product sharing groups.

/event/group/sharing/products/create

(Patch Set 7) This event is generated when a /group/sharing/products object is created for an account or service.

/event/group/sharing/products/delete

(Patch Set 7) This event is generated when a /group/sharing/products object is deleted for an account or service.

/event/group/sharing/products/modify

(Patch Set 7) This event is generated when a /group/sharing/products object is modified for an account or service.

/group/sharing/products

(Patch Set 7) Stores a list of products for the owner of a product sharing group.

/config/calendar/silent_days

(Patch Set 6) Stores all calendar days that are considered silent days. Messages cannot be sent to customers on these days.

/config/deposit

(Patch Set 6) Stores configuration data for deposits.

/config/deposit_spec_profile

(Patch Set 6) Stores the common business rules for the deposits in your organization.

/deposit_refund_request

(Patch Set 6) Stores information about an account's deposit refund status.

/deposit_specification

(Patch Set 6) Stores the configuration for a deposit specification.

/event/billing/deposit

(Patch Set 6) Stores details about a deposit event.

/event/billing/deposit/reversal

(Patch Set 6) Stores details about a deposit reversal event.

/event/billing/deposit/interest

(Patch Set 6) Event created when interest is applied to a deposit.

/event/billing/deposit/interest/credit

(Patch Set 6) Event created when interest is applied to a credit card deposit.

/event/billing/deposit/interest/debit

(Patch Set 6) Event created when interest is applied to a debit deposit.

/event/billing/loan_grant

(Patch Set 6) Stores details about a loan grant event.

/event/billing/loan_late_fee

(Patch Set 6) Event created when a late payment fee is applied for a late loan repayment.

/event/billing/loan_pullback

(Patch Set 6) Event created when the amount due for a loan is pulled from the customer's main balance.

/event/billing/loan_recovery

(Patch Set 6) Event created when a loan grant is recovered from a customer.

/event/billing/loan_recovery_reversal

(Patch Set 6) Event created when a customer reverts a loan payment.

/event/billing/product/fee/purchase/deposit

(Patch Set 6) Event created when a deposit fee associated with a product is applied.

/event/billing/product/fee/purchase/deposit/refund

(Patch Set 6) Event created when a deposit refund fee associated with a product is applied.

/event/deposit

(Patch Set 6) Stores a deposit event.

/event/deposit/collected

(Patch Set 6) Event created when a deposit is collected.

/event/deposit/create

(Patch Set 6) Event created when a deposit is created.

/event/deposit/receive

(Patch Set 6) Event created when a deposit is received.

/event/deposit/refund

(Patch Set 6) Event created when a deposit is refunded.

/event/deposit/refund/approved

(Patch Set 6) Event created when the request for a deposit refund is approved.

/event/deposit/refund/rejected

(Patch Set 6) Event created when the request for a deposit refund is rejected.

/event/deposit/refund/request

(Patch Set 6) Event created when a deposit refund is requested.

/event/deposit/release

(Patch Set 6) Event created when a deposit is released.

/event/deposit/reversal

(Patch Set 6) Event created when a deposit is reversed.

/event/deposit/transfer

(Patch Set 6) Event created when a deposit is transferred.

/event/deposit/update

(Patch Set 6) Event created when a deposit is updated.

/item/deposit

(Patch Set 6) Stores details about a deposit.

/item/deposit/charge

(Patch Set 6) Stores details about a deposit charge.

/item/deposit/interest

(Patch Set 6) Stores details about interest on a deposit.

/item/deposit/interest/credit

(Patch Set 6) Stores details about deposit interest applied to a credit card.

/item/deposit/interest/debit

(Patch Set 6) Stores details about deposit interest applied to debits.

/item/deposit/refund

(Patch Set 6) Stores details about a refunded deposit.

/item/deposit/refund/fee

(Patch Set 6) Stores details about a refund deposit fee.

/item/deposit/reversal

(Patch Set 6) Stores details about a deposit reversal.

/item/loan_late_fee

(Patch Set 6) Stores details about late fees applied to a loan.

/purchased/deposit

(Patch Set 6) Stores details about a purchased deposit.

/request

(Patch Set 6) A base class for recording a request or transaction for review.

/request/failed

(Patch Set 6) Stores the error summary for a failed request.

/request/failed/opcode

(Patch Set 6) Stores information about the opcode called as part of the failed request.

/request/failed/rest

(Patch Set 6) Stores information about the failed request from the REST API.

/config/delivery_methods

 (Patch Set 5) Stores the supported delivery methods, such as email or IVR, for notifications.

/config/event_promo_map

(Patch Set 5) Stores the mapping between events and promotional events for applying event-based promotions.

/config/event_promo_tag_map

(Patch Set 5) Stores the mapping between promotional tags and promotional events.
/config/loan (Patch Set 5) A configuration object that stores loan parameters.

/config/notification_spec

(Patch Set 5) Stores notification specifications.

/config/taxcodes_map

(Patch Set 5) Stores your tax codes.

/config/taxexemption_code_map

(Patch Set 5) Stores details about each tax exemption code.

/event/audit/transfer_balance

(Patch Set 5) Stores an audit event for tracking individual balance transfers between balance groups.

/event/billing/fee/balance_transfer

(Patch Set 5) Stores the balance transfer fee for the target or source account.
/event/billing/loan_credit (Patch Set 5) Stores details about a loan event.
/event/billing/loan_debit (Patch Set 5) Stores details about a loan event.
/event/billing/loan_fee (Patch Set 5) Stores details about a loan fee event.
/event/billing/loan_grant (Patch Set 5) Stores details about a loan that also grants non-currency resources. You configure charge offers in PDC to grant the resources for this event.

/event/billing/topup

(Patch Set 5) Stores details about a top-up applied to an account.

/installment_schedule

(Patch Set 5) Stores details about an installment payment plan.

/item/installment

 (Patch Set 5) Stores details about an installment.
/item/loan_credit (Patch Set 5) Stores details about a loaned amount.
/item/loan_debit (Patch Set 5) Stores details about the asset representing a loan.
/item/loan_fee (Patch Set 5) Stores details about a loan fee.
/offering_override_values (Patch Set 5) Stores details for overriding a rate for a period of time.
/profile/loan (Patch Set 5) A profile object that stores loan parameters specific to a customer or service.

/profile/specialdates

(Patch Set 5) Stores extended account attributes such as special dates. These attributes are used to apply promotions based on the occurrence of special dates.

/schedule/notification

(Patch Set 5) Stores deferred actions for notifications.

/tax_exemption_selector

(Patch Set 5) Stores information about tax exemption selectors, which can be used to apply tax exemptions based of different attributes.

/config/note_type

(Patch Set 4) Stores information for account-level notes in Billing Care.
/deliverable (Patch Set 4) Stores details about deliverables.
/deliverable/product (Patch Set 4) Stores details for a physical good deliverable type.
/deliverable/service (Patch Set 4) Stores details about these deliverable types: one-time activities, metered services, and continuous services.
/entitlement (Patch Set 4) Stores entitlement information about deliverables.
/entitlement/allowance (Patch Set 4) Stores entitlement information for continuous service deliverables.
/entitlement/allowance/onetime (Patch Set 4) Stores entitlement information for one-time activity deliverables.
/entitlement/allowance/recurring (Patch Set 4) Stores entitlement information for metered service deliverables.
/entitlement/feature (Patch Set 4) Stores entitlement information for metered service deliverables.
/event/activity/job_request (Patch Set 4) Stores audit data when the PCM_OP_JOB_EXECUTE opcode calls an application in a non-job context.
/offer_attribute_group (Patch Set 4) Stores extended attributes defined for pricing components.

/performance_snapshot/realtime

(Patch Set 4) Store monitoring information for BRM cloud native.

/performance_sql_data

(Patch Set 4) Store monitoring information for BRM cloud native.
/revenue_basis_item (Patch Set 4) Stores entitlement information for metered service deliverables.
/revenue_basis_item/rate_based (Patch Set 4) Stores revenue basis data, such as the standalone selling price and earning schedule, for continuous service and physical good deliverables.
/revenue_basis_item/value_based (Patch Set 4) Stores revenue basis data, such as the standalone selling price and earning schedule, for metered service and one-time activity deliverables.

/event/job_template

(Patch Set 3) Stores a notification event for job_template processing.

/event/job_template/create

(Patch Set 3) Stores a create event for the job_template.

/event/job_template/modify

(Patch Set 3) Stores a modify event for job_template.

/event/job_template/delete

(Patch Set 3) Stores a delete event for job_template.

/job_definition

(Patch Set 3) Stores the job's running location and usage summary.

/job_template/custom

(Patch Set 3) Stores the command for running the custom Business Operations job.

/history_subscriber_contract

(Patch Set 2) Stores a copy of the subscriber contract data. This class is created when a contract is renewed or modified.

/subscriber_contract

(Patch Set 2) Stores the subscriber contract data.

/cmt_balances

(Patch Set 2) Stores the balance data temporarily.

/tmp_ar_item_to_roll_up

(Patch Set 1) Stores information for the A/R items of the nonpaying child bill units to roll them up to the paying parent bill unit.

/event/activity/roll_up

(Patch Set 1) Records activity related to rolling of items up to the paying parent bill unit.

/recurring_bundle_history

(Patch Set 1) Stores information about recurring bundles.

Changed Storable Classes

Table 8-2 lists the storable classes that have been modified in the BRM 12.0 patch set releases.

Table 8-2 Changed Storable Classes

Changed Storable Class Description

/config/business_events

(Patch Set 8) Contains this new field under the PIN_FLD_EVENTS array:

  • PIN_FLD_NOTIFY_SEARCH_LEVEL specifies the level to consolidate multiple events into a notification: create a separate notification for each event (1), consolidate an account's events into one notification (2), consolidate a balance group's events into one notification (3), consolidate a service's events into one notification (4), and consolidate a bill unit's events into one notification (5).

    Note: This field is applicable only for notifications sent in advance or after expiration.

/config/distribution

(Patch Set 8) Contains this new field under the PIN_FLD_DISTRIBUTION array:

  • PIN_FLD_SCHEMA_NAME specifies the name of the schema.

/config/notification_spec

(Patch Set 8) Contains these new fields under the PIN_FLD_NOTIFICATION_SPEC array:

  • PIN_FLD_NOTIFY_OPT_TYPE specifies to opt-out customers from receiving notification messages by default (1), to opt-in customers for receiving notification messages by default (2), or to enforce opt-in preferences for customers (3).
  • PIN_FLD_AGGREGATE_MODE specifies whether to send separate notifications for each event (0) or to consolidate details from multiple events into one notification (1).

/deal

/event/billing/discount/action

/purchased_discount

(Patch Set 8) Contains this new field under the PIN_FLD_DISCOUNTS array:

  • PIN_FLD_GRACE_PERIOD specifies the grace period for this offering.

/process_audit/billing

(Patch Set 8) Contains this new field under the PIN_FLD_FAILED_ACCOUNTS array:

  • PIN_FLD_SCOPE_OBJ contains a link to the failed object's POID.

/product

(Patch Set 8) Contains these new fields:

  • PIN_FLD_OFFER_VALIDITY_ROUNDING specifies the offer validity rounding at the product level. The default is 0.
  • PIN_FLD_SCALE_ROUNDING specifies the scale rounding at the product level. The default is 0.

/service

(Patch Set 8) Contains these new fields:

  • PIN_FLD_SVC_EXP_LAST_NOTI_T specifies the last time this object was processed for a SERVICE_STATE_EXPIRATION_T notification.
  • PIN_FLD_SVC_EXP_LAST_NOTI_OFFSET specifies the offset the last time this object was processed for a SERVICE_STATE_EXPIRATION_T notification.
/balance_group

(Patch Set 7) Contains these new fields under the PIN_FLD_BALANCES array:

  • PIN_FLD_ROLLED_UP_CREDIT_LIMIT specifies the credit limit to roll up in a billing hierarchy.

/collections_scenario

(Patch Set 7) Contains these new fields under the PIN_FLD_PROMISE_TO_PAY array:

  • PIN_FLD_STATUS specifies the status of a collections action: pending (0), canceled (1), completed (2), kept (3), or broken (4).
  • PIN_FLD_CONFIG_SPEC_OBJ contains a link to a /config/collections/promise_to_pay_spec object.
/config/business_events (Patch Set 7) The PIN_FLD_EVENT_TYPE field includes this new value:
  • AFTER-DUE-DATE specifies that notifications for this business event can be sent after an event occurs.

/config/credit_profile

(Patch Set 7) Contains these new fields in the PIN_FLD_PROFILES array:

  • PIN_FLD_DYNAMIC_CREDIT_FLOOR specifies whether to use a dynamic credit floor: use the existing credit floor for credit limit breach checks (0) or dynamically update the credit floor for a given period of time (1).
  • PIN_FLD_OVERRIDE_CREDIT_LIMIT specifies whether to override the credit limit: the credit limit is set based on the rating mode (0) or the credit limit is overridden (0x01).
/config/notification_spec (Patch Set 7) The following fields include new values:
  • PIN_FLD_EVENT_NAME includes these additional values: PostBalanceExpiry, PostBillDue, PostProductExpiry, PostSubscriptionRenewalDue, PostCollectionsActionDue, PostInstallmentDue.
  • PIN_FLD_EVENT_TYPE includes the new AFTER-DUE-DATE value.

/deal

(Patch Set 7) Contains these new fields under the PIN_FLD_PRODUCTS array:

  • PIN_FLD_FLAGS specifies how to prorate at the product level: default system configuration (0), 30-day proration (1), or number of days in the month (2).
  • PIN_FLD_BASE_PRODUCT_OBJ contains a link to the base product object.

/discount

(Patch Set 7) Contains this new field:

  • PIN_FLD_APPLY_MODE specifies whether to trigger automatic sharing group creation (1) or not (0).

/event

(Patch Set 7) Contains these new fields under the PIN_FLD_SUB_BAL_IMPACTS array:

  • PIN_FLD_CURRENT_BAL specifies the total available balance for this resource.
  • PIN_FLD_AVAILABLE_LOAN_BALANCE specifies the loan balance available for this resource.

/event/activity/collections/promise_to_pay

(Patch Set 7) Contains this new array:

  • PIN_FLD_MILESTONES contains the promise-to-pay information for unequal installments and unequal intervals.

/event/billing/limit

(Patch Set 7) Contains these new fields in the PIN_FLD_LIMIT array:

  • PIN_FLD_DYNAMIC_CREDIT_FLOOR specifies whether to use a dynamic credit floor: use the existing credit floor for credit limit breach checks (0) or dynamically update the credit floor for a given period of time (1).
  • PIN_FLD_OVERRIDE_CREDIT_LIMIT specifies whether to override the credit limit: the credit limit is set based on the rating mode (0) or the credit limit is overridden (0x01).

/event/billing/product/action

(Patch Set 7) Contains this new field in the PIN_FLD_ACTION_INFO array:

  • PIN_FLD_BASE_PRODUCT_OBJ contains a link to the base product object.

/plan

(Patch Set 7) Contains these new fields in the PIN_FLD_LIMIT array:

  • PIN_FLD_OVERRIDE_CREDIT_LIMIT specifies whether to override the credit limit: the credit limit is set based on the rating mode (0) or the credit limit is overridden (0x01).
  • PIN_FLD_DYNAMIC_CREDIT_FLOOR specifies whether to use a dynamic credit floor: use the existing credit floor for credit limit breach checks (0) or dynamically update the credit floor for a given period of time (1).

/product

(Patch Set 7) Contains this new field:

  • PIN_FLD_APPLY_MODE specifies whether to trigger automatic sharing group creation (1) or not (0).

/purchased_deposit

(Patch Set 7) Contains these new fields:

  • PIN_FLD_PARENT contains a link to the parent purchased deposit object. This is set when the deposit amount is updated.
  • PIN_FLD_END_DETAILS is an encoded field holding mode, unit, and offset. The mode is always relative (4) occupying 8 bits starting from LSB. The unit can be months (0), days (1), weeks (2), and years (3), occupying 4 bits after mode. The offset is the value for unit, occupying 20 bits after unit.

/purchased_product

(Patch Set 7) Contains this new field:

  • PIN_FLD_BASE_PRODUCT_OBJ contains a link to the base product object.
/balance_group (Patch Set 6) Contains these new fields under the PIN_FLD_SUB_BALANCES array:
  • PIN_FLD_SUBTYPE specifies the type of sub-balance, which can be default (0), loan (1), or temporary credit limit (2).
/collections_action (Patch Set 6) Modified to sending messages to customers through external notification applications. It contains these new fields:
  • PIN_FLD_LAST_NOTIFICATION_T specifies the last time this object was processed for expiration notifications.
  • PIN_FLD_LAST_NOTIFICATION_OFFSET specifies the offset the last time this object was processed.
/config/business_events (Patch Set 6) Modified to support notifications in Billing Care. The object's PIN_FLD_EVENT_TYPE field is now set to one of the following:
  • IN_ADVANCE: Specifies that notifications for this business event can be sent several days before an event occurs.
  • REGULAR: Specifies that notifications for this business event can be sent immediately or at a specific time of day.
/config/credit (Patch Set 6) Contains these new fields:
  • PIN_FLD_LOAN_THRESHOLDS: Percent threshold for loan notifications.
  • PIN_FLD_LOAN_THRESHOLDS_FIXED: Fixed threshold for loan notifications.
/config/delivery_methods (Patch Set 6) Modified to sending messages to customers through external notification applications. It contains this new field:
  • PIN_FLD_DELIVERY_IDENTIFIER_TAG specifies the delivery identifier tag.

/event/billing/cycle/tax

(Patch Set 6) The PIN_FLD_TAXES array contains the new PIN_FLD_ITEM_OBJ field, which holds the corresponding charge item POID.

/event/billing/limit (Patch Set 6) Modified to support temporary credit limits. It contains these new fields:
  • PIN_FLD_SUB_BAL_IMPACTS array specifies the temporary credit limit.
/event/billing/loan_fee (Patch Set 6) Modified to include the PIN_FLD_AMOUNT field to indicate the loan amount.
/event/billing/payment/cc (Patch Set 6) Contains these new fields:
  • PIN_FLD_TRACE_NUMBER specifies the trace number returned by Paymentech for PINless debit authorization.
  • PIN_FLD_AUTH_MOP specifies the Method of Payment (MOP) used to process the PINless debit authorization.
/event/billing/product/action (Patch Set 6) The PIN_FLD_NEXT_RETRY_T field is added to record when a subscription for which the subscriber has insufficient balance will next be retried.
/installment_schedule (Patch Set 6) Modified to sending messages to customers through external notification applications. It contains these new fields:
  • PIN_FLD_LAST_NOTIFICATION_T specifies the last time this object was processed for expiration notifications.
  • PIN_FLD_LAST_NOTIFICATION_OFFSET specifies the offset the last time this object was processed for an end date notification.

  • In the PIN_FLD_INSTALLMENTS array, the PIN_FLD_LAST_NOTIFICATION_OFFSET field specifies the offset the last time this object was processed for an installment due notification.

/item

(Patch Set 6) Modified to include the PIN_FLD_TAX_DATA field, which holds tax-related data about an item such as the tax code, amount taxed, tax, and amount of tax adjusted.
/payinfo/cc (Patch Set 6) Contains these new fields:
  • PIN_FLD_TYPE_STR specifies the card type indicator. The first character indicates whether the card supports PINless debit transactions: Y specifies supports, N specifies does not support, and X specifies unknown.
/plan (Patch Set 6) Contains these new fields:
  • PIN_FLD_LOAN_THRESHOLDS: Percent threshold for loan notifications.
  • PIN_FLD_LOAN_THRESHOLDS_FIXED: Fixed threshold for loan notifications.
/profile/loan (Patch Set 6) Contains these new fields:
  • PIN_FLD_OPT_LOAN: This value indicates whether customer opted for loan or not. 0 indicates opt_out and 1 indicates opt_in. By default, the value is set to 0.
  • PIN_FLD_MAX_ACTIVE_LOANS: This value indicates maximum number of active loans
  • PIN_FLD_REPAYMENT_DAYS: This field stores the days for loan repayment
  • PIN_FLD_PULLBACK: This field provides an option to enable or disable loan pullback if the loan is not repaid within the
  • PIN_FLD_REPAYMENT_DAYS. 0 indicates disable pullback and 1 indicates enable pullback. By default, the value is set to 0.
  • PIN_FLD_LIMIT: This array stores the CREDIT_LIMIT which will override the FIXED_MAXIMUM or SCALED_MAXIMUM in /config/loan.
  • PIN_FLD_VALID_FROM: Start date for PIN_FLD_CREDIT_LIMIT
  • PIN_FLD_CREDIT_LIMIT: Maximum loan amount which can be granted
/product (Patch Set 6) These new fields are used when PIN_FLD_TYPE for the rate is set to 745, 747, or 748:
  • PIN_FLD_MAX_RETRY_COUNT: The maximum number of times to retry the subscription before failing.
  • PIN_FLD_RETRY_UNIT: The unit for the retries. Valid values are:
    • 1: Seconds
    • 2: Minutes
    • 3: Hours
    • 4: Days
    • 5: Months
    • 6: Years
    • 10: Weeks
  • PIN_FLD_RETRY_OFFSET: The frequency of retries.
/purchased_product (Patch Set 6) The PIN_FLD_NEXT_RETRY_T field is added to record when a subscription for which the subscriber has insufficient balance will next be retried.
/rate (Patch Set 6) PIN_FLD_TYPE is modified to support new values for exceeding credit limits:
  • 747: Charge a minimum amount if a customer has less than the full amount. You can optionally prorate the service according to the amount charged.
  • 748: Subscription fails and is canceled after the configured number of retries. Retries are configured in a business parameter or in the /product object.

These new fields are used when PIN_FLD_TYPE for the rate is set to 747:

  • PIN_FLD_MINIMUM_SCALED_AMOUNT: The minimum amount to charge for the service if the customer does not have sufficient balance.
  • PIN_FLD_PRORATE_QUANTITY: Whether to prorate the service if the minimum amount is charged (1) or not (0). The default is 1.

/balance_group

(Patch Set 5) Contains these new fields:

  • PIN_FLD_LAST_NOTIFICATION_T specifies the last time this object was processed for expiration notifications.
  • PIN_FLD_LAST_NOTIFICATION_OFFSET specifies the offset the last time this object was processed.
  • PIN_FLD_DELTA_CREDIT_LIMIT specifies the credit limit for the balance group that includes loans and any related fees and taxes.
  • PIN_FLD_OUTSTANDING_AMOUNT specifies outstanding amounts remaining after an existing balance is used up when exceeding a credit limit.

/batch/rel

(Patch Set 5) Contains these new fields to handle new processing options for the Rated Event Manager:

PIN_FLD_FILES is an array that contains elements that each correspond to a file of CDR data for this batch Rated Event Loader session. Each element contains the following fields:

  • PIN_FLD_STATUS contains the processing status of the file.
  • PIN_FLD_FILENAME contains the tracking file name used for this CDR data file.
  • PIN_FLD_NUM_TOTAL_RECORDS contains the number of distinct events in the data file.
  • PIN_FLD_BUFFER contains the content of a CDR file in ZIP format.

PIN_FLD_STATUSES is an array that contains elements that each correspond to the status of a retry attempt for a Rated Event Loader session. Each element contains the following fields:

  • PIN_FLD_CREATED_T contains the creation time for the retry record.
  • PIN_FLD_PROCESS_START_T contains the time that the retry attempt was started.
  • PIN_FLD_PROCESS_END_T contains the time that the retry attempt was completed.
  • PIN_FLD_STATUS contains the processing state of the retry attempt.

/bill

(Patch Set 5) Contains these new fields:

  • PIN_FLD_LAST_NOTIFICATION_T specifies the last time this object was processed for expiration notifications.
  • PIN_FLD_LAST_NOTIFICATION_OFFSET specifies the offset the last time this object was processed.
  • PIN_FLD_STATE specifies the state of the bill: UNDEFINED, INPROGRESS, NEW, PARTIALLYPAID, SETTLED, ONHOLD, SENT, or VALIDATED.

/config/beid

(Patch Set 5) Contains the new PIN_FLD_ENABLE_EXPIRY_NOTIFICATION field, which specifies whether to generate notifications if a customer's balance is about to expire.
/config/credit_profile (Patch Set 5) Contains new fields to configure the thresholds for triggering automatic loans:
  • PIN_FLD_RESRC_FIXED_THRESHOLD
  • PIN_FLD_RESRC_PERC_THRESHOLD

/config/subscriber_preferences_map

(Patch Set 5) The PIN_FLD_TYPE field supports three new values: 6 (TIME), 7 (MULTI SELECT ENUM), and 262 (TIME RANGE).

/deal

(Patch Set 5) Contains these new fields in the PIN_FLD_PRODUCTS array:

  • PIN_FLD_RENEWAL_MODE specifies whether a reactivated product's cycle is aligned with the original purchase date or the reactivation date.
  • PIN_FLD_GRACE_PERIOD_OFFSET specifies the amount of the grace period.
  • PIN_FLD_GRACE_PERIOD_UNIT specifies the unit of the grace period, which can be seconds, minutes, hours, or days.
/event (Patch Set 5) The PIN_FLD_OUTSTANDING_AMOUNT field is added in the PIN_FLD_BAL_IMPACTS array.This field specifies outstanding amounts remaining after an existing balance is used up when exceeding a credit limit.

/event/billing/discount/action

(Patch Set 5) Contains these new fields:

  • PIN_FLD_OFFERING_OVERRIDE_VALUES_OBJ contains the POID of the /offering_override_values object associated with this discount.
/event/billing/product/action

(Patch Set 5) Contains these new fields:

  • PIN_FLD_RENEWAL_MODE specifies whether a reactivated product's cycle is aligned with the original purchase date or the reactivation date.
  • PIN_FLD_GRACE_PERIOD_OFFSET specifies the amount of the grace period.
  • PIN_FLD_GRACE_PERIOD_UNIT specifies the unit of the grace period, which can be seconds, minutes, hours, or days.
  • PIN_FLD_OFFERING_OVERRIDE_VALUES_OBJ contains the POID of the /offering_override_values object associated with the product.

/history_bills

(Patch Set 5) Contains these new fields:

  • PIN_FLD_LAST_NOTIFICATION_T specifies the last time this object was processed for expiration notifications.
  • PIN_FLD_LAST_NOTIFICATION_OFFSET specifies the offset the last time this object was processed.

/product

(Patch Set 5) Contains the new PIN_FLD_ENABLE_NOTIFICATION field, which specifies whether to generate notification events for subscriptions that contain this charge offer when it is about to expire or renew. Possible values are:

  • Both product expiration and subscription renewal notifications are enabled (3)
  • Product expiration notifications are disabled and subscription renewal notifications are enabled (2)
  • product expiration notifications are enabled and subscription renewal notifications are disabled (1)
  • Both product expiration and subscription renewal notifications are disabled (0)

Also, the existing PIN_FLD_FLAGS field in the PIN_FLD_USAGE_MAP array includes a new possible value of RATE_LIFECYCLE_SUSPEND (0x04), which specifies to continue charging the product when the life cycle state is suspended.

/profile/subscriber_preferences

(Patch Set 5) Contains the new PIN_FLD_SUBSCRIBER_PREFERENCES array, which specifies an account's subscriber preferences.

/purchased_discount

(Patch Set 5) Contains these new fields:

  • PIN_FLD_OFFERING_OVERRIDE_VALUES_OBJ contains the POID of the /offering_override_values object associated with this discount.
/purchased_product

(Patch Set 5) Contains these new fields:

  • PIN_FLD_LAST_NOTIFICATION_T specifies the last time this object was processed for expiration notifications.
  • PIN_FLD_LAST_NOTIFICATION_OFFSET specifies the offset the last time this object was processed.
  • PIN_FLD_RENEWAL_MODE specifies whether a reactivated product's cycle is aligned with the original purchase date or the reactivation date.
  • PIN_FLD_GRACE_PERIOD_OFFSET specifies the amount of the grace period.
  • PIN_FLD_GRACE_PERIOD_UNIT specifies the unit of the grace period, which can be seconds, minutes, hours, or days.
  • PIN_FLD_RETRY_COUNT specifies how many times the subscription has been retried when the credit limit has been exceeded.
  • PIN_FLD_OFFERING_OVERRIDE_VALUES_OBJ contains the POID of the /offering_override_values object associated with this product.
/rate

(Patch Set 5) Contains these new fields:

  • PIN_FLD_PRORATION_FLAG specifies how to apply cycle fees when customers change their billing DOM in the middle of a billing cycle: apply the full cycle fee (701), do not apply the cycle fee (703), or prorate the cycle fee (0).
  • PIN_FLD_SCALED_PRICE_TAG specifies the price tag for the scaled amount.
  • PIN_FLD_FIXED_PRICE_TAG specifies the price tag for the fixed amount.
  • PIN_FLD_SPLIT_DETAILS is a 32-bit field that specifies the logic for creating multiple validity periods:
    • The lower 8 bits specify the expiration mode for the incremental validity period: bucket (5) or total (6).
    • The second 4 bits specify the units for the incremental validity period: seconds (1), minutes (2), hours (3), days (4), months (5).
    • The remaining 20 MSB bits specify the amount for the validity period.
  • PIN_FLD_TYPE is modified to support new values for exceeding credit limits:
    • 742: Use available balance and grant a loan for the rest.
    • 743: Use available balance and record the rest as an outstanding amount.
    • 744: Don't use available balance and record the entire amount as an outstanding amount.
    • 745: Don't exceed the credit limit and fail the subscription.
    • 746: Skip billing for this cycle.

/topup

(Patch Set 5) Modified to support top-ups of noncurrency resources and recurring top-ups, and proration during state changes. It contains these new fields:

  • PIN_FLD_RESOURCE_ID specifies the resource to top up during recurring top ups.
  • PIN_FLD_TOPUP_INTERVAL specifies the interval between recurring top ups.
  • PIN_FLD_NEXT_TOPUP_T specifies the date on which to perform the next top up.
  • PIN_FLD_NUM_TOPUPS specifies the maximum number of top ups that can be done for recurring top ups. A value of 0 indicates that the recurring top up continues forever.
  • PIN_FLD_NUM_TOPUPS_DONE specifies the number of recurring top ups that have been completed. When this reaches PIN_FLD_NUM_TOPUPS, the recurring top up will be stopped.
  • PIN_FLD_STATUS specifies the object's status: active or closed.
  • PIN_FLD_BAL_GRP_OBJ specifies the balance group in which sub-balances need to be topped up.
  • PIN_FLD_TYPE specifies the top-up type: automatic (0), one-time (1), or recurring (2).

/transition

(Patch Set 5) Modified to support proration of cycle fees during state changes. It contains a new PIN_FLD_PRORATION_FLAG field, which specifies how to apply cycle fees when customers transition from one package or bundle to another: prorate both the current and new cycle fees (1), apply the current bundle's fee to this cycle, and then start applying the new bundle's fee next cycle (2), or start applying the new bundle's fee to this cycle, and fully refund the current bundle's fee (4).

/config/glid (Patch Set 4) Contains a new PIN_FLD_TYPE field that specifies the GLID type: Standard (0), A/R (1), Revenue (2), Contract (3).
/deal

(Patch Set 4) Contains new fields:

  • PIN_FLD_ATTRIBUTE_OBJ specifies the POID of the /offer_attribute_group object containing extended attributes for the /deal object
  • PIN_FLD_MODE, under the PIN_FLD_PRODUCTS and PIN_FLD_DISCOUNTS arrays, specifies what happens if customers purchase the same product in the deal more than once.
/discount (Patch Set 4) Contains a new PIN_FLD_ATTRIBUTE_OBJ field that specifies the POID of the /offer_attribute_group object containing extended attributes for the /discountobject.
/event/billing/charge/cc (Patch Set 4) Modified to support Card Type Indicators (CTIs). It includes a new PIN_FLD_TYPE_STR field under PIN_FLD_CC_INFO, which is used to store the CTI returned by Paymentech.
/event/billing/product/action (Patch Set 4) Contains these new fields:
  • PIN_FLD_CALENDAR_DOM specifies a specific calendar day to apply cycle, usage, and purchase fees.
  • PIN_FLD_MODE specifies what happens if customers purchase the same product more than once.
/event/billing/validate/cc (Patch Set 4) Modified to support CTIs. It includes a new PIN_FLD_TYPE_STR field under PIN_FLD_CC_INFO, which is used to store the CTI returned by Paymentech.

/job_template

(Patch Set 4) Modified to support Business Operations Center on a multischema system. It contains a new PIN_FLD_SCHEMAS array for storing the schema number on which to run a job.
/plan (Patch Set 4) Contains a new PIN_FLD_ATTRIBUTE_OBJ field that specifies the POID of the /offer_attribute_group object containing extended attributes for the /plan object.
/product (Patch Set 4) Contains new fields:
  • PIN_FLD_ATTRIBUTE_OBJ specifies the POID of the /offer_attribute_group object containing extended attributes for the /product object
  • PIN_FLD_CALENDAR_DOM specifies a specific calendar day to apply cycle, usage, and purchase fees.
  • PIN_FLD_DATE_RANGE_TYPE specifies whether to select a rate for the product based on the event date, purchase date, or service instantiation date
/purchased_product (Patch Set 4) Contains new fields:
  • PIN_FLD_CALENDAR_DOM specifies a specific calendar day to apply cycle, usage, and purchase fees
  • PIN_FLD_MODE specifies what happens if customers purchase the same product more than once
/sponsorship (Patch Set 4) Contains a new PIN_FLD_ATTRIBUTE_OBJ field that specifies the POID of the /offer_attribute_group object containing extended attributes for the /sponsorship object.
/event/billing/charge/cc (Patch Set 2) Modified to support stored-credential transactions.
/event/billing/validate/cc (Patch Set 2) Modified to support stored-credential transactions.
/event/customer/nameinfo (Patch Set 2) Modified to store the POID of the /nameinfo object that changed and is populated for service-level contact information.
/job/boc (Patch Set 2) Modified to run workflow jobs in Business Operations Center.
/job_template/billing (Patch Set 2) Modified to run workflow jobs in Business Operations Center.
/job_template/collect (Patch Set 2) Modified to support workflow jobs in Business Operations Center.
/job_template/invoice (Patch Set 2) Modified to support workflow jobs in Business Operations Center.
/job_template/ledger_report (Patch Set 2) Modified to support workflow jobs in Business Operations Center.
/payinfo/cc (Patch Set 2) Modified to store card credentials for future transactions.
/rate (Patch Set 2) Modified to support enhancements in BRM 12.0 Patch Set 2.
/service (Patch Set 2) Modified to support enhancements in BRM 12.0 Patch Set 2.
/tmp_journals_to_process (Patch Set 1) Modified to store information for the journals of the nonpaying child bill units to roll them up to the paying parent bill unit.