10 Accounts Receivable Utilities
Learn about the syntax and parameters used by the Oracle Communications Billing and Revenue Management (BRM) accounts receivable utilities.
Topics in this document:
pin_apply_bulk_adjustment
Use this BRM command-line utility to apply an adjustment across a broad range of accounts, such as all accounts charged a regular day-time rate when they should have been charged a holiday rate. See "Adjusting Multiple Accounts Simultaneously".
Location
BRM_home/bin
Syntax
pin_apply_bulk_adjustment [-verbose file_name.log] [-test] [-h] -f input_file.csv
Parameters
Results
Each account adjustment initiated during a bulk adjustment is handled as a separate transaction. Therefore, if any single adjustment in the bulk adjustment fails, BRM does not need to roll back the entire bulk adjustment. Rather, the adjustment remains in place for all accounts that had successful adjustments, and the utility identifies the accounts that failed to adjust so you can correct the problem. The utility provides this feedback in a log file (default.pinlog) that it generates in its start directory or in a directory specified by the configuration file.
pin_mass_refund
Use this utility to create a refund for accounts that have a credit balance. See "Giving Refunds to Customers".
Note:
For multischema systems, you must run the utility separately against each database schema in your system. See "Running Non-MTA Utilities in Multischema Systems" in BRM System Administrator's Guide.
Location
BRM_home/bin
Syntax
pin_mass_refund -active|-close|-inactive [-pay_type payment_method] [-test] [-verbose file_name.log] [-test] [-help]
Parameters
- -active | -close | -inactive
-
Specifies the status of the accounts for which to create refund items.
- -pay_type payment_method
-
Specifies the payment method, for example:
-
10003 for credit card
-
10005 for direct debit
-
10018 for SEPA
-
- -test
-
Finds the bill units (/billinfo objects) that meet the criteria but does not create any refund objects.
- -verbose
-
Displays information about successful or failed processing as the utility runs.
- -help
-
Displays syntax and parameters for this utility.
Results
If the utility does not notify you that it was successful, look in the utility log file (default.pinlog) to find any errors. The log file is either in the directory from which the utility was started, or in a directory specified in the configuration file.
pin_refund
Use this utility to find accounts that have refund items and make BRM-initiated refund payments to customers. See "Giving Refunds to Customers".
When you use multiple payment processors, you run this utility for each one. See "Using More Than One Payment Processor" in BRM Configuring and Collecting Payments.
Location
BRM_home/bin
Syntax
pin_refund -pay_type payment_type_indicator [-vendor payment_processor_name] [-active | -close | -inactive] [-verbose file_name.log] [-test] [-help]
Parameters
- -pay_type payment_type_indicator
-
Specifies the payment type, for example:
-
10003 for credit card
-
10005 for direct debit
-
10018 for SEPA
-
- -vendor payment_processor_name
-
Specifies the credit card processor or automated clearing house (ACH) to use for validating credit cards, debit cards, and direct debit transactions.
This parameter is not applicable for the SEPA payment type.
For information on configuring payment processor information, see BRM Configuring and Collecting Payments.
- -active | -close | -inactive
-
Specifies the status of the accounts to give refunds to.
- -verbose
-
Displays information about successful or failed processing as the utility runs.
- -test
-
Returns the number of refund items that would be created, but does not create any refund items.
- -help
-
Displays syntax and parameters for this utility.
Results
If the utility does not notify you that it was successful, look in the utility log file (default.pinlog) to find any errors. The log file is either in the directory from which the utility was started, or in a directory specified in the configuration file.
When it is called internally by the pin_bill_day script, the pin_refund utility logs error information in the pin_billd.pinlog file.
pin_roll_up_ar_items
Use the pin_roll_up_ar_items utility to process temporary A/R items (/tmp_ar_item_to_roll_up object) of nonpaying child bill units and then roll up the balance impacts to the corresponding A/R items in the paying parent bill unit. You can run multiple threads of pin_roll_up_ar_items to process A/R items for different paying parent bill unit.
You must run this utility before billing the paying parent bill unit. For more information, see "Rolling A/R Actions Up to the Wholesale Parent" in BRM Configuring and Running Billing.
Note:
To connect to the BRM database, the pin_roll_up_ar_items utility needs a configuration file in the directory from which you run the utility. See "Connecting BRM Utilities" in BRM System Administrator's Guide.
Location
BRM_home/bin
Syntax
pin_roll_up_ar_items [-verbose] [-help]
Parameters
Results
If the pin_roll_up_ar_items utility does not notify you that it was successful, look in the utility log file (default.pinlog) to find any errors. The log file is either in the directory from which the utility was started or in a directory specified in the configuration file.
Error Handling
When the pin_roll_up_ar_items utility encounters an error while processing the A/R items in the temporary tables, it sets the PIN_FLD_BILLING_STATUS billing status field of the paying parent bill unit (/billinfo object) to PIN_BILL_ERROR. In addition, it sets the appropriate bit of the PIN_FLD_BILLING_STATUS_FLAGS field of the /billinfo object as PIN_BILL_FLAGS_UPDATE_ITEMS_ERROR (bit value 0x4000).
After you have resolved the processing errors, you can reprocess the A/R items by running the pin_roll_up_ar_items utility again.