Table of Contents
- Title and Copyright Information
- Preface
-
Part I Opcode Reference
-
1
Opcode Descriptions
- About Using Opcodes
- Account Dump FM Policy Opcodes
- Account Dump FM Standard Opcode
- Accounts Receivable FM Policy Opcodes
- Accounts Receivable FM Standard Opcodes
- Account Synchronization FM Opcodes
- Activity FM Policy Opcodes
- Activity FM Standard Opcodes
- Balance FM Policy Opcodes
- Balance FM Standard Opcodes
- Base Opcodes
- Batch Suspense Manager FM Standard Opcodes
- Billing FM Policy Opcodes
- Billing FM Standard Opcodes
- Channel FM Standard Opcodes
- Collections Manager FM Policy Opcodes
- Collections Manager FM Standard Opcodes
- Contract FM Policy Opcodes
- Contract FM Standard Opcodes
- Customer FM Policy Opcodes
- Customer FM Standard Opcodes
- Customer Care FM Standard Opcodes
- Deposit FM Policy Opcodes
- Deposit FM Standard Opcodes
- Device FM Policy Opcodes
- Device FM Standard Opcodes
- Email Data Manager Opcodes
- General Ledger FM Policy Opcodes
- General Ledger FM Standard Opcode
- GPRS Manager 3.0 FM Policy Opcode
- GPRS Manager 3.0 FM Standard Opcode
- Group FM Standard Opcodes
- GSM Manager FM Policy Opcode
- GSM Manager FM Standard Opcode
- Installment FM Policy Opcodes
- Installment FM Standard Opcodes
- Invoicing FM Policy Opcodes
- Invoicing FM Standard Opcodes
- IP Address Manager APN FM Policy Opcodes
- IP Address Manager FM Policy Opcodes
- IP Address Manager FM Standard Opcodes
- Job FM Standard Opcodes
- LDAP Base Opcodes
- Loan FM Policy Opcodes
- Loan FM Standard Opcodes
- Monitor FM Standard Opcodes
- Notification FM Standard Opcodes
- Notification FM Policy Opcodes
- Number Manager FM Policy Opcodes
- Number Manager FM Standard Opcodes
- Offer Profile FM Standard Opcode
- Order FM Policy Opcodes
- Order FM Standard Opcodes
- Payment FM Policy Opcodes
- Payment FM Standard Opcodes
- Permissioning FM Standard Opcodes
- Process Audit FM Policy Opcodes
- Process Audit FM Standard Opcodes
- Provisioning FM Policy Opcode
- Provisioning FM Standard Opcodes
- Publish FM Policy Opcodes
- Rating FM Policy Opcodes
- Rating FM Standard Opcodes
- Remittance FM Policy Opcodes
- Remittance FM Standard Opcodes
- Replication FM Policy Opcode
- Rerating FM Standard Opcode
- SDK FM Standard Opcodes
- Services Framework Manager FM Policy Opcodes
- Services Framework Manager FM Provisioning Opcodes
- SIM Manager FM Policy Opcodes
- SIM Manager FM Standard Opcodes
- Subscription Management FM Policy Opcodes
- Subscription Management FM Standard Opcodes
- Suspense Manager FM Standard Opcodes
- Universal Message Store (UMS) FM Standard Opcodes
- 2 Context Management Opcodes
-
1
Opcode Descriptions
-
Part II Opcode Workflows
- 3 About Opcode Workflows
-
4
Accounts Receivable Opcode Workflows
- Opcodes Described in This Chapter
- Getting a List of A/R Items
- Reversing Refunds
- Transferring Amounts between Items
- Managing Currency and Non-Currency Balance Transfers between Accounts or Services
- Transferring Services between Balance Groups
- Performing Adjustments
-
Performing Disputes and Settlements
- Disputing Bills
- Settling Disputed Bills
- Disputing Items
- Settling Disputed Items
- Disputing Events
- Settling Disputed Events
- Configuring the Tax Treatment for Adjustments, Disputes, and Settlements
- Including Taxes in the Dispute or Settlement
- Including Reason Codes in the Dispute or Settlement
- Assigning G/L IDs for a Dispute or Settlement
- Writing Off Debts and Reversing Write-Offs
-
Retrieving A/R Information
- Finding a Bill
- Finding a Bill Unit
- Getting a List of Bills
- Getting Bill Items
- Getting Bills
- Finding Items
- Retrieving a Balance Summary
- Retrieving a List of Bills for a Bill Unit
- Retrieving A/R Items That Apply to a Bill Unit
- Retrieving a List of Bill Items for a Bill Unit
- Retrieving Details about a Specific A/R Item or Bill Item
- Retrieving Dispute Details for a Bill Unit
- Retrieving Details on Available Balances
- Finding Events Associated with an Account
- Finding Events Associated with Bill Items
- Performing Rollover Transfers
- 5 Activity Opcode Workflows
-
6
Billing Opcode Workflows
- Opcodes Described in This Chapter
- Creating Bills
- Customizing Billing
-
Managing Bill Units
- Creating Bill Units
- Updating Bill Units
- Preparing Bill Unit Data
- Validating Bill Unit Data
- Suspending and Resuming Billing of Closed Accounts
- Deleting Bill Units
- Setting Up Hierarchical and Sharing Relationships among Bill Units
- Changing Hierarchical and Sharing Relationships among Bill Units
- Billing Delays for Moved Bill Units
- Suppressing Bills
- Making Trial Bills
- Corrective Billing
- Using Revenue Assurance Manager
-
7
Charging Opcode Workflows
- Opcodes Described in This Chapter
- Subscription Rating Opcodes
- Implementing Custom Rating
- Getting ERAs for an Event
- Modifying Rated Events
- Modifying ERAs
- Managing Credit Limits and Sub-Balance Consumption Rules
- Maintaining Subscriber's Charging Preferences Data
- Modifying Events before Sending Them to ECE
- Rerating Opcodes
-
Suspense Management
- Suspended Call Record States
- Recycling Suspended Records
- Initiating Suspense Recycling
- Changing the Contents of Fields in Suspended Event Records
- Undoing Edits to Suspended Event Records
- Deleting Suspended Records
- Deleting Call Records with a Specific Recycle Key and a Status of Succeeded or Written-Off
- Writing Off Suspended Records
- Processing Suspended Records in Bulk
- Provisioning Process Opcode Flow
- GPRS Opcodes
-
8
Collections Opcode Workflows
- Opcodes Described in This Chapter
-
Customizing Collections Manager
- Configuring the Currency Used in Collections
- Customizing Due Dates
- Customizing Dunning Letters
- Applying Finance Charges
- Applying Late Fees
- Assigning Bill Units Automatically
- Assigning Bill Units to a Debt Collections Agency
- Customizing How to Apply Collections Actions to Collections Group Members
- Mapping Bill Units to Collections Profiles
- Performing Custom Collections Actions
- Performing Custom Actions when a Bill Unit Leaves Collections
-
Managing Overdue Balance Collection
- Creating or Updating Collections Actions
- Creating or Updating Collections Profiles
- Getting All Currently Defined Collections Actions
- Getting All Currently Defined Collections Profiles
- Getting All Currently Defined Collections Scenarios
- Getting Details of a Collections Scenario
- Getting a List of Message Templates
- Deleting an Existing Collections Action
- Deleting an Existing Collections Profile
- Deleting an Existing Collections Scenario
-
Managing Promise-to-Pay Agreements
- Creating a System-Configured Promise-to-Pay Agreement
- Creating a Manually Configured Promise-to-Pay Agreement
- Updating Amount and Payment Details
- Canceling a Promise-to-Pay Agreement
- Breaking a Promise-to-Pay Agreement
- Rescheduling a Promise-to-Pay Action
- Changing the Status of a Promise-to-Pay Action
- Completing Promise-to-Pay Installments during Payment Processing
- Managing Collections Groups
- Performing Manual Collections Actions
- Performing System Collections Actions
- Retrieving Collections Information
-
9
Customer Management Opcode Workflows
- Opcodes Described in This Chapter
- About Account Locking
- Transaction Handling During Account Creation
-
Creating Accounts
- Customizing Account Numbers
- Customizing the Introductory Message
- Sending the Introductory Message
- Customizing Account Creation Charges
- Creating Multiple Accounts in One Transaction
- Creating Accounts with Backdated Services or Balances
- Creating Customer's Collections Profiles at the Time of Customer Account Creation
- Customizing Automatic Account Creation (AAC) Information
- Adding Custom Account Creation Steps Before the Account Is Committed
- Adding Custom Account Creation Steps After the Account Is Committed
- Integrating BRM With an External Account Creation Application
- Returning a Point-of-Presence (POP) List
- Creating Accounts in a Multischema System
- Managing Name and Address Information
- Authenticating and Authorizing Customers
- Managing and Customizing Profiles
- Modifying an Account
- Creating Services
- Modifying Services
- Finding Accounts
- Deleting Accounts
- Customizing Customer Payment Information
- Setting Account, Service, and Bill Unit Status
- Getting Life Cycle States
- Amending Creditor Information
- Amending a Mandate
- Canceling a Mandate
- Managing Deferred Actions
-
Managing Service Groups
- Creating a Service Group
- Configuring Extended Rating Attributes for a Service Group
- Associating a Device with a Service Group
- Adding a Service to an Existing Service Group
- Canceling a Service Group
- Transferring Service Groups between Accounts in the Same Schema
- Transferring Service Groups between Accounts in Different Schemas
- Managing Profile Sharing Groups
- Using Access Control Lists
- Customizing the Account Dump Utility (ADU)
- Business Profile Opcode Workflows
-
Creating and Managing Account Hierachies
- Creating Account Hierarchies
- Adding Accounts to Account Hierarchies
- Moving Accounts from One Account Hierarchy to Another
- Deleting Accounts from Account Hierarchies
- Deleting Account Hierarchies
- Finding the Parent of an Account Hierarchy
- Getting a List of Child Accounts in an Account Hierarchy
- About the PCM_OP_GROUP Opcodes
-
10
Deposit Opcode Workflows
- Opcodes Described in This Chapter
- Creating Deposit Specification Profiles
- Validating Deposit Specification Profiles
- Getting Deposit Specification Profiles
- Modifying Deposit Specification Profiles
- Creating Deposit Specifications
- Validating Deposit Specifications
- Getting Deposit Specifications
- Modifying Deposit Specifications
- Deleting Draft Deposit Specifications
- Purchasing Deposits
- Validating a Deposit Purchase
- Getting Deposits
- Updating Deposits
- Validating Deposit Updates
- Collecting Deposit Payments
- Validating Deposit Payment Collections
- Reversing Deposits
- Validating a Deposit Reversal
- Releasing Deposits
- Validating a Deposit Release
- Transferring Deposits
- Validating a Deposit Transfer
- Adding Interest to a Deposit
- Customizing the Interest Calculation
- Requesting Deposit Refunds
- Validating a Deposit Refund Request
- Getting Refund Requests
- Updating Refund Requests
- Updating Received Deposits
- Triggering Deposits
- Retrieving Transaction Details of a Deposit
- 11 Device Management Opcodes
-
12
General Ledger Opcode Workflows
- Opcodes Described in This Chapter
- How G/L IDs Affect Storage and Reporting of G/L Data
- How BRM Records the Difference between Rounded and Unrounded Items
- Customizing G/L Data Stored in /journal Objects
- Customizing G/L Reports for Export
- Assigning G/L IDs to Prerated Events
- How BRM Exports G/L Reports
- How BRM Stores General Ledger Reports
-
13
Group Opcode Workflows
- Opcodes Described in This Chapter
- Managing Sharing Groups
- Managing Ordered Balance Groups
-
Adding and Removing Members Automatically to
Sharing Groups
- Adding Members to Newly Created Sharing Groups Automatically
- Adding Members to Hierarchy-Type Balance Monitors
- Adding Members to Payment Responsibility-Type Balance Monitors
- Adding Members to Hierarchy-Type Sharing Groups Automatically
- Adding Members to Paying Responsibility-Type Sharing Groups Automatically
- Updating Subscription-Type Monitors Automatically
- Removing Members from Balance Monitor Groups
- Removing Members from Sharing Groups
- Displaying Balance Monitor Information in Client Applications
- Updating Monitor Balances and Sending Credit Limit/Threshold Breach Notifications
- Managing Balance Monitors
- Managing Balance Groups
- Converting an Account Hierarchy to Wholesale Billing
-
14
Installment Opcode Workflows
- Opcodes Described in This Chapter
- Creating Installment Schedule Specifications
- Validating Installment Schedule Specifications
- Preparing Installment Schedule Specifications
- Modifying Installment Schedule Specifications
- Retrieving Installment Schedule Specifications
- Getting Installment Schedule Specifications
- Creating Installments
- Validating Installments
- Preparing Installments
- Applying Installment Charge
- Updating Installment Status
- Retrieving Installments
- Updating Installments
- Canceling Installments
- Installment Proposal
-
15
Invoice Opcode Workflows
- Opcodes Described in This Chapter
- Setting the Default Payment Due Date
- Making Invoices
- Displaying Invoices
- Defining the Invoice Type
-
How Invoices Are Formatted
- Customizing the Layout of Bill Items in Invoices
- Customizing the Format for Printed Invoices
- Customizing the Format for HTML Invoices
- Customizing the Format for XML Invoices
- Customizing the Invoice Format by Using an XSL Style Sheet
- Customizing the Format for DOC1 Invoices
- Displaying an Invoice On Demand
- Including Custom Data in Invoices
- Including the Time Zone in Invoices
- Adding Soft Descriptors to Invoices
- Specifying Event Fields to Cache for Invoicing
- Decoding Cached Event Data for Invoicing
- How Invoices Are Generated
- Customizing Invoice Search Operations
- Generating Trial Invoices
- 16 Job Opcode Workflows
- 17 Loan Opcode Workflows
-
18
Notification Opcode Workflows
- Opcodes Described in This Chapter
- Creating Notification Specifications
- Modifying Notification Specifications
- Retrieving Notification Specifications
- Managing In-Advance and Post-Expiration Notifications
- Calculating the Notification Delivery Time
- Verifying Customer Opt-In Preferences
- Retrieving Last Notification Time and Offset
- Customizing Notifications
- 19 Number Manager and SIM Card Manager Opcode Workflows
-
20
Payment Opcode Workflows
- Opcodes Described in This Chapter
- Collecting Payments
-
BRM-Initiated Payment Processing
- Initiating a Charge
- Processing Credit Card Charges
- Processing the Results of Credit Card Transactions
- Processing Paymentech Address Validation Return Codes
- Processing Direct Debit Charges
- Processing a Batch of Direct Debit Charges
- Checking the Results of BRM-Initiated Batch Payment Operations
- Validating Credit Card and Direct Debit Transactions
- Processing Credit Card Information during Account Creation
- Storing Card Credentials for Future Transactions
- About Credit Card Payment Confirmation Numbers
- Externally Initiated Payment Processing
- Receiving Payments
- Validating Payments
- Configuring Unconfirmed Payment Processing
- Handling Overpayments and Underpayments
- Calculating Payment Collection Dates
- How BRM Selects the Items to Which Payments Are Applied
- Allocating Account Payments to Multiple Bill Units
- Reversing Payments
- Refunding Payments
- Writing Off Payments
- Finding Payment Info
- Adding a Custom Payment Method
- How Opcodes Read the Payment Method
- Processing Payment Fees
- Processing Payment Incentives
- Managing Top-Ups
-
Suspending and Recycling Payments
- How BRM Tracks Suspended Payments
- Customizing Payment Suspense
- About the Suspense Account
- Suspending Payments during Payment Processing
- How Payments Are Recycled to and from Suspense
- Understanding Payment Recycling
- Retrieving Recycled Payments
- How Suspended Payments Are Reversed
- How BRM Handles Mandate Information for SEPA Processing
-
21
Subscription Opcode Workflows
- Opcodes Described in This Chapter
- Pricing Component Object Names
-
Managing Charge Offers
- Purchasing Charge Offers
- Backdating Charge Offer, Discount Offer, Bundle, or Package Purchases
- Applying Purchase and Cycle Fees to the Balance
- How Charge Offers Are Modified
- How BRM Changes Charge Offer Status
- How Charge Offers Are Canceled
- Customizing Charge Offer Cancellation
- Customizing How to Apply Folds
- Managing Discount Offers
- Managing Bundles
- Managing Packages
- Managing Contracts
-
Managing Purchase, Cycle, and Usage Charges in Purchased Offers
- Changing the Purchase, Usage, and Cycle Start and End Times
- Overriding Charges and Discounts for a Period of Time
- Specifying Purchase, Cycle, and Usage Start and End Times
- Calculating the Cycle Forward Fee
- Calculating the Cycle Arrears Fee
- Cycle Arrears Charge Offer Limitations
- About Backdated Purchase, Usage, or Cycle End Dates
- Storing Relative Start and End Times for an Account's Charge Offers and Discount Offers
- Applying Recurring Charges
- Applying Folds
-
Getting Data about Bundles, Charge Offers, Discount Offers, and Services
- Getting Purchased Offers
- Getting Packages, Bundles, and Charge Offers for Purchase
- Getting a List of Bundles, Charge Offers, Discount Offers, and Services
- Getting a List of Packages and Bundles That an Account Owns
- Reading Data for All Valid Purchased Charge Offers and Discount Offers
- Finding Events Associated with Bundles, Charge Offers, Discount Offers, and Services
- Getting a Life-Cycle State
- Applying Promotions for Special Dates, Events, or Actions
- Managing Promotions with Siebel CRM
- Managing Provisioning
- Validating Product Specification Attributes for Pricing Components
-
22
Tax Calculation Opcode Workflows
- Opcodes Described in This Chapter
- Calculating Taxes during Billing
- Modifying Tax Data Before Calculating Taxes
- Modifying Tax Data After Calculating Taxes
- Overriding Customer Tax Locale for Purchases
- Using Custom Tax Rates
- Using Geocodes to Calculate Taxes
- Adding Tax Information to Accounts
- Retrieving Tax Calculation Data
- Retrieving Additional Tax Data from Vertex Communications Tax Q Series
-
23
Using the IP Address Manager APIs
- Opcodes Described in This Chapter
-
Managing Your IP Address Device Life Cycle
- Creating a Single IP Address Device
- Creating a Range of IP Address Devices
- Creating a Range of IP Addresses with a Subnet Mask
- Customizing IP Address Creation
- Associating an IP Address with Accounts or Services
- Disassociating an IP Address Device from Accounts or Services
- Changing IP Device States from Unallocated to Returned
- Modifying an IP Address Device
- Sorting IP Devices by Using Canonical IP Address
- Deleting an IP Address Device
- Managing your APN Device Life Cycle
- Extending the IP Address Manager Storable Classes
- Adding Business Logic to the IP Address and APN Policy FMs