Search Results lock_settlement_doc

Overview

OZF_SETTLEMENT_DOC_PVT is a private PL/SQL package in the Oracle E-Business Suite Trading Community and Trade Management (formerly ETRM/OSM) schema, owned by APPS and declared with AUTHID CURRENT_USER. It serves as the internal engine that creates, validates, and maintains settlement documents, the transactional records that reconcile claims against payments, adjustments, and receivables activity. Within the context of the user's search for "debt relief settlement fee," this package governs how a settlement amount — including any fee or relief component captured on a claim — is converted into an auditable settlement document, tied to a claim line, and propagated to the appropriate sub-ledger (Payables or Receivables) through the payment method recorded on the claim.

The package defines the settlement_doc_rec_type record and settlement_doc_tbl_type collection, which mirror the OZF_SETTLEMENT_DOCS entity. Attributes such as settlement_amount, settlement_acctd_amount, discount_taken, status_code, gl_date, and the descriptive flexfield columns (attribute_category, attribute1–15) are carried through the record structure. The header revision marker ($Header: ozfvcsds.pls 120.2) indicates the package has been stable since Release 11i and remains the underlying implementation used by both 12.1.1 and 12.2.2. It is classified as PVT (private), meaning it is intended to be called only by other ETRM packages, not directly by customers.

Key Procedures and Functions

Each of the 17 documented procedures and functions supports a stage in the settlement document lifecycle:

• CREATE_SETTLEMENT_DOC / UPDATE_SETTLEMENT_DOC / DELETE_SETTLEMENT_DOC — core DML operations that insert, modify, and remove settlement document rows.
• LOCK_SETTLEMENT_DOC — obtains a row-level lock to prevent concurrent modification during processing.
• VALIDATE_SETTLEMENT_DOC, CHECK_SETTLE_DOC_ITEMS, CHECK_SETTLE_DOC_RECORD — validation routines that verify required fields and referential integrity before commit.
• COMPLETE_SETTLE_DOC_REC — finalizes a settlement document record, typically setting status and GL date.
• CREATE_SETTLEMENT_DOC_TBL / UPDATE_SETTLEMENT_DOC_TBL — bulk (table-based) variants of the single-record operations, used for high-volume processing.
• POPULATE_SETTLEMENT_DATA — populates the working record/collection from claim and payment sources.
• UPDATE_PAYMENT_DETAIL — writes back payment-related detail, including discount_taken and payment_reference information.
• UPDATE_CLAIM_FROM_SETTLEMENT — reflects settlement results back onto the originating claim and claim line.
• GET_PAYABLE_SETTLEMENT, GET_RECEIVABLE_SETTLEMENT, GET_RMA_SETTLEMENT — retrieval functions that return settlement candidates for the payable, receivable, and RMA return flows respectively.

Tables Accessed

The package reads and writes across claims, order, and financial sub-ledger tables:

• OZF_CLAIMS, OE_ORDER_HEADERS_ALL — source claim and order context for the settlement.
• AP_INVOICES_ALL, AP_INVOICE_PAYMENTS_ALL, AP_CHECKS_ALL — Payables-side invoice, payment, and check references used when settlement is paid.
• AR_ADJUSTMENTS, AR_PAYMENT_SCHEDULES, AR_RECEIVABLES_TRX, AR_RECEIVABLE_APPLICATIONS — Receivables-side adjustments, schedules, transactions, and applications supporting receivables and RMA settlements.
• HZ_CUST_ACCOUNTS_ALL, HZ_PARTIES — customer account and party verification for the settlement recipient.

Usage Notes

Because it is a PVT package, OZF_SETTLEMENT_DOC_PVT is not invoked directly by end users. It is referenced by four other ETRM packages and is called from settlement-related forms (such as the Claim and Settlement windows in Trade Management) and from concurrent programs that generate or reconcile settlement documents. Customizations should call the higher-level public API rather than this package, since its signature is not guaranteed across patches. In both 12.1.1 and 12.2.2 the package behavior is consistent; no OAF-specific refactoring altered its logic.