Search Results update_cm_related_columns

Overview

ARP_PS_UTIL is a Receivables utility package that centralizes low-level maintenance logic for the AR_PAYMENT_SCHEDULES table. In Oracle EBS 12.1.1 and 12.2.2, PAYMENT_SCHEDULES rows represent the installments that make up a customer transaction, tracking amounts due, amounts applied, adjustments, discounts, and the associated accounting dates. Rather than permitting applications, receipts, credit memos, and adjustments to update those columns directly, Receivables routes the changes through the utility procedures in ARP_PS_UTIL, which validate the requested values before the row is amended.

The package therefore functions as a gatekeeper for the receivables transaction balance. Its procedures enforce the argument-checking rules that prevent a payment schedule from becoming internally inconsistent—for example, applying more than the remaining amount due, or posting a GL date outside a permissible window. The package also exposes date utility routines, including GET_CLOSED_DATES and POPULATE_CLOSED_DATES, which support determination of the closed and GL dates assigned to a payment schedule.

ARP_PS_UTIL is classified as a utility (UTIL) object under the APPS schema. It is not an end-user-facing API; it is a shared internal building block used by other Receivables packages.

Key Procedures and Functions

The ETRM metadata documents nine procedures and functions within this package body. They fall into three broad groups.

• UPDATE_REVERSE_ACTIONS — Supports the reversal workflow for payment schedule activity, reapplying the balance effects when a prior application or adjustment is undone.
• UPDATE_RECEIPT_RELATED_COLUMNS — Maintains the payment schedule columns driven by cash receipt application, keeping amounts applied and related dates synchronized with the receipt activity.
• UPDATE_INVOICE_RELATED_COLUMNS — Updates the payment schedule columns affected by invoice-related activity, including discount amounts taken as earned or unearned.
• UPDATE_CM_RELATED_COLUMNS — Handles the payment schedule updates that arise when a credit memo is applied against a transaction.
• UPDATE_ADJ_RELATED_COLUMNS — Maintains the amounts recorded against the line, tax, freight, and receivables charges adjustment buckets, along with the pending adjustment amount.
• GET_CLOSED_DATES — Returns the closed and GL dates applicable to a payment schedule, used by calling code to determine the appropriate accounting date.
• POPULATE_CLOSED_DATES — Populates the closed date values on the payment schedule, completing a payment schedule when its balance reaches zero. The procedure header is declared publicly within the package, a point noted in the embedded comments regarding the NOCOPY parameter.

The remaining documented routines are the internal validation procedures—including the argument validators that check the payment schedule identifier, amount applied, earned and unearned discount, adjustment amounts, apply date, and GL date before an update is permitted.

Tables Accessed

The package reads and writes the core Receivables transaction tables through APPS synonyms:

• AR_PAYMENT_SCHEDULES and AR_PAYMENT_SCHEDULES_ALL — the primary target of the update procedures, holding the installment balance and date columns.
• AR_RECEIVABLE_APPLICATIONS and AR_RECEIVABLE_APPLICATIONS_ALL — the application records whose line, tax, freight, and charges amounts drive adjustment-related updates.
• AR_ADJUSTMENTS — adjustment transactions that feed the adjustment update logic.
• RA_CUSTOMER_TRX and RA_CUST_TRX_TYPES — transaction and transaction type information used to resolve the context of the payment schedule being maintained.

Usage Notes

ARP_PS_UTIL is invoked indirectly rather than through direct customer calls. It is referenced by nine other packages, meaning Receivables application logic, AutoAccounting, receipt application, adjustment, and credit memo processing reach this utility when they need to modify payment schedule balances. It is not exposed through a standard Receivables form or a standalone concurrent program.

Because POPULATE_CLOSED_DATES and GET_CLOSED_DATES are documented as public procedures, custom extensions that need to reconcile or complete payment schedule dates may call them, but doing so should be treated as a modification of core Receivables data. Any custom code should follow the same argument validation path the package enforces, since bypassing the validators risks corrupting the transaction balance.