Results for “iex_promises_pub”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

APPS.IEX_PROMISES_PUB is the public PL/SQL API for the Oracle E-Business Suite Advanced Collections (IEX) module. Its core business function is the creation, maintenance, and cancellation of customer payment promises (PTPs) recorded against delinquent receivables. A "promise" represents a commitment by a customer to pay a specific amount by a specific date, and serves as a foundational collection instrument used to drive collection strategies, workflow activities, and delinquency resolution.

The package header is annotated with the representative metadata tag @rep:displayname IEX Promises API and is classified as a public API (@rep:scope public) for the business entity IEX_PROMISES with active lifecycle status and @rep:compatibility S (supported). The header comment "Creates a promise" reflects the primary insert path, though the package exposes additional lifecycle operations. The package header defines richly typed record structures, including ATTRIBUTE_REC_TYPE (15 descriptive flexfield attribute columns) and PRO_INSRT_REC_TYPE, which carries the required and optional attributes of a promise such as PROMISE_AMOUNT, CURRENCY_CODE, PROMISE_DATE, PROMISE_PAYMENT_METHOD, PROMISE_TARGET, CUST_ACCOUNT_ID, DELINQUENCY_ID, CNSLD_INVOICE_ID, and CONTRACT_ID.

Key Procedures and Functions

The ETRM metadata documents seven procedures/functions within this package:

• INSERT_PROMISE — Creates a new payment promise record. Uses the PRO_INSRT_REC_TYPE record, which requires a positive amount, a currency matching the promise object's original currency, a unique promise date for the object, and a valid promise target (ACCOUNTS, INVOICES, CNSLD, or CONTRACTS).
• UPDATE_PROMISE — Modifies an existing promise record, allowing collection agents to revise promise terms such as amount, date, or payment method.
• CANCEL_PROMISE — The procedure most closely associated with the user's search term "cancel_promise." It marks a promise as cancelled, terminating the commitment without deleting the historical record. This is a critical operation when a customer breaks a promise or when a promise is superseded.
• MASS_PROMISE — Enables bulk creation of promises across multiple promise objects, supporting high-volume collections scenarios where a customer commits to a payment plan covering several delinquencies or invoices.
• SET_STRATEGY — Associates or assigns a collection strategy to the promise context, linking promise activity to the strategic delinquency workflow defined in IEX_STRATEGIES.
• SHOW_IN_UWQ — Controls visibility of promise-related tasks within the Universal Work Queue (UWQ), ensuring collectors see actionable promise items.
• UPDATE_DEL_STAGE_LEVEL — Updates the delinquency stage level, advancing or adjusting the status of the underlying delinquency as promise activity occurs.

Tables Accessed

The package reads and writes several core Advanced Collections and shared Oracle tables via APPS synonyms:

• IEX_PROMISE_DETAILS / IEX_PROMISE_DETAILS_S — The primary storage for promise records and their sequence; all insert, update, and cancel operations affect these tables.
• IEX_DELINQUENCIES / IEX_DELINQUENCIES_ALL — Referenced to link promises to delinquency records and to update delinquency stage levels.
• IEX_STRATEGIES — Consulted by SET_STRATEGY to resolve and assign collection strategies.
• AR_PAYMENT_SCHEDULES — The underlying receivable schedule used to validate promise amounts and currencies against the original transaction.
• HZ_PARTIES — Provides customer party information for promises made at the account level.
• IEX_PTP_WF_S — Supporting workflow staging table for promise-to-pay process flow.
• DBMS_SQL, DUAL, PLITBLM — Utility objects used for dynamic SQL, single-row queries, and index-by table plumbing.

Usage Notes

IEX_PROMISES_PUB is typically invoked from the Advanced Collections application forms (such as the Promise to Pay workbench), from concurrent programs that batch-process promises, and from custom extensions requiring programmatic promise management. The CANCEL_PROMISE and INSERT_PROMISE procedures are the most commonly called externally. Because this is a documented public API classified as PUB, customers may call it directly, but should not modify underlying tables directly to preserve integrity. It is referenced by at least one other package, and downstream workflow and strategy processing depends on its proper use. Compatibility is rated "S" (Supported) across the 12.1.1 and 12.2.2 releases.