Search Results settle_mass_settlement




Overview
Explore in AI Chat

Overview

OZF_MASS_SETTLEMENT_PVT is a private PL/SQL API within the Oracle E-Business Suite Trade Management (formerly Oracle Trade Management / iReceivables Claims) module. It is owned by the APPS schema and is compiled with AUTHID CURRENT_USER, meaning that all unqualified object references resolve against the privileges of the invoking session rather than the package owner. The package encapsulates the business logic required to settle multiple trade claims — deductions, promotional accruals, and similar trade promotion obligations captured in Oracle Claims — in a single batch operation. Its source header ($Header: ozfvmsts.pls 120.2.12010000.2 2008/08/01) confirms it has been part of the product since at least the 11i era and was maintained through Release 12.

In the 12.1.1 and 12.2.2 releases, the package remains classified as a PVT (private) API. Private APIs are not intended for direct invocation by external or customer-developed code; they are called internally by other Oracle Trade Management packages. The ETRM metadata records that OZF_MASS_SETTLEMENT_PVT is referenced by three other packages, which act as the public-facing entry points for mass settlement processing.

The central business purpose is to take a set of open claims, a set of open transactions (typically AR invoices or credit memos), and a set of payment method instructions, then apply settlements against those open items in a coordinated manner. The amount_settled attribute appears repeatedly across the package's record type definitions — in group_claim_rec, open_claim_rec, open_transaction_rec, and claim_payment_method_rec — reflecting the fact that settlement amount is the principal input and output of every stage in the process.

Key Procedures and Functions

The package exposes three documented procedures:

  • SETTLE_MASS_SETTLEMENT — The core settlement routine. It accepts a group-level claim record, a table of open claims, a table of open transactions, and a table of payment method records, then performs the application of settlement amounts across those claims and transactions. The amount_settled column carried in each of these collection types is the value written back to the underlying claim and receivable application records. This procedure is the workhorse of the package.
  • START_MASS_PAYMENT — Initiates a mass payment run. It begins the process of generating settlement documents and applying payments against the identified open items, coordinating with the underlying AR payment and receivables application records.
  • REJECT_MASS_PAYMENT — Handles rejection or reversal of a mass payment. This allows a settlement batch that has been created but not finalized to be backed out, restoring the affected claims and transactions to their prior open state.

All three procedures follow the standard EBS API convention of returning x_return_status, x_msg_data, and x_msg_count for error handling, and supporting p_commit and p_init_msg_list control flags.

Tables Accessed

The package reads and writes a range of Trade Management and Receivables tables through APPS synonyms:

  • AMS_CUSTOM_SETUPS_B / AMS_CUSTOM_SETUP_ATTR — Custom setup configuration, providing extensibility attributes leveraged during settlement.
  • AR_PAYMENT_SCHEDULES — AR payment schedules, where the amount_settled value in the input records is derived and where the actual settlement amount is recorded via receivable application.
  • AR_RECEIVABLE_APPLICATIONS — The application records created when a settlement amount is applied against an invoice; this table stores the applied amount_settled.
  • OZF_CLAIMS and OZF_CLAIMS_ALL — The Oracle Claims header tables, containing the claims being settled. The claim_id, claim_number, and claim_class fields in the record types map directly here.
  • OZF_CLAIM_LINES_ALL — Claim line detail, representing the individual components of a claim that contribute to the total amount_settled.
  • OZF_CLAIM_TYPES_ALL_B / OZF_CLAIM_DEF_RULES_ALL — Claim type and rule definitions that govern how settlement is calculated and applied.
  • OZF_SETTLEMENT_DOCS_ALL — The settlement document records generated by the mass settlement process.
  • OZF_SYS_PARAMETERS — System parameters controlling Trade Management behavior.
  • RA_CUSTOMER_TRX — AR transactions (invoices/credit memos) that are the counterparties to the claims; the open_transaction_rec type carries customer_trx_id from this table.
  • PLITBLM — A standard EBS PL/SQL table used for message or transaction handling.

Usage Notes

Because OZF_MASS_SETTLEMENT_PVT is a PVT API, it should not be called directly from customer-developed code. The metadata confirms it is referenced by three other packages, which provide the supported public interfaces. In practice, mass settlement is invoked through the Oracle Trade Management user interface (the Claims workbench / mass settlement form) or through a concurrent program that processes claims in bulk. The form collects user selections of open claims and open transactions and the desired payment method, then passes them into this package via the referencing public APIs.

The presence of amount_settled throughout the record structures means any custom integration that mimics this package's contract must supply consistent settlement amounts at the group, claim, transaction, and payment-method levels. Organizations maintaining custom code around Trade Management should upgrade-check against Release 12.1.1 and 12.2.2, as the header indicates a 2008 change (Bug 5345095, which added wo_adj_trx_id).