Search Results ozf_mass_settlement_pvt




Overview
Explore in AI Chat

Overview

APPS.OZF_MASS_SETTLEMENT_PVT is the private API package body that implements mass settlement and mass payment processing for Oracle Trade Management (formerly Oracle Field Sales/OZF) claims within Oracle E-Business Suite 12.1.1 and 12.2.2. The package provides the backend logic used to close, pay, and reject large batches of customer claims and settlement documents in a single operation, rather than requiring users to settle each claim individually. It is classified as a PVT (private) API, meaning its procedures are intended to be called by other EBS program units — chiefly the mass settlement UI and its associated concurrent processing — rather than being published for general customer integration use. The header comment identifies the source file as ozfvmstb.pls, with the package authored against the OZF schema family that underpins Oracle Trade Management.

Key Procedures and Functions

The ETRM 12.2.2 metadata documents three procedures on this package. In addition, the source excerpt shows internal helper logic including a Close_Claim procedure, which updates a claim to a paid and closed state, and a Pay_by_Open_Receipt routine used in settlement processing. The three documented entry points are:

  • SETTLE_MASS_SETTLEMENT — the principal driver that performs mass settlement for a selected set of claims or settlement documents, coordinating payment creation and claim closure as a single logical operation.
  • START_MASS_PAYMENT — initiates the mass payment workflow, typically by invoking the payment engine or concurrent process that actually disburses funds against the selected claims.
  • REJECT_MASS_PAYMENT — reverses or rejects an in-progress or failed mass payment, restoring the affected claims and settlement documents to a consistent state so that they can be corrected or retried.

These procedures follow the standard EBS API conventions visible in the source: an x_return_status OUT parameter returning FND_API constants such as g_ret_sts_success and g_ret_sts_unexp_error, and exception handlers that post messages through FND_MSG_PUB, including debug-level diagnostics when OZF_DEBUG_LOW_ON or OZF_DEBUG_HIGH_ON is enabled. No parameter lists beyond those documented should be assumed.

Tables Accessed

The package reads and writes a range of Trade Management and Receivables tables through APPS synonyms. Claim data is maintained in OZF_CLAIMS and OZF_CLAIMS_ALL — the latter is updated by Close_Claim to set payment_status, status_code, and a default user status derived via OZF_UTILITY_PVT. Claim configuration and structure are read from OZF_CLAIM_TYPES_ALL_B, OZF_CLAIM_DEF_RULES_ALL, and OZF_CLAIM_LINES_ALL. Settlement documents reside in OZF_SETTLEMENT_DOCS_ALL. On the financial side, the package interacts with AR_PAYMENT_SCHEDULES and AR_RECEIVABLE_APPLICATIONS for open receipts and applications, RA_CUSTOMER_TRX for transactions, and OZF_SYS_PARAMETERS for system-level setup values. AMS_CUSTOM_SETUPS_B and AMS_CUSTOM_SETUP_ATTR provide flexfield and custom setup metadata, while PLITBLM is the standard EBS PL/SQL table used for batch processing and array handling.

Usage Notes

OZF_MASS_SETTLEMENT_PVT is invoked by three other packages, which handle the user-facing forms and orchestration layers of the mass settlement flow. In practice it is reached when a user selects multiple claims in a Trade Management settlement form and submits a mass settlement, mass payment, or mass payment rejection action, or when the corresponding concurrent programs execute in the background. Because the package is classified as a PVT API, direct calls from custom code are discouraged; developers should call the public mass settlement wrapper or submit the supported concurrent program instead. Any custom invocation must still meet the package's prerequisites — valid claim and settlement document records, accessible open receipts in Receivables, plus correct OZF_SYS_PARAMETERS and AMS custom setup configuration.