Search Results ozf_settlement_docs

Overview

The APPS.OZF_AR_SETTLEMENT_PVT package body is a private (PVT) API within the Oracle E-Business Suite Trade Management / Channel Revenue Management (formerly Oracle Trade Management, product family OZF) schema. Its primary business function is to manage the settlement of trade promotion claims and deductions against Oracle Receivables. It orchestrates the end-to-end settlement lifecycle: identifying eligible claims, validating payment methods and claim classifications, preparing settlement and payment instructions, creating settlement documents, generating corresponding Oracle Receivables and General Ledger entries, and closing out claims when settlement is complete.

As a PVT-classified package, it is not intended as a public integration interface; instead it supports the higher-level public APIs (notably OZF_AR_SETTLEMENT_PUB) and the underlying claim, payment, and settlement document packages. It is documented as VALID in both Oracle EBS 12.1.1 and 12.2.2, and it references 3 other packages while not itself being referenced by any database object, consistent with its role as an internal implementation module.

Key Procedures and Functions

The metadata documents 18 procedures and functions. Grouped by purpose:

• Context and setup: SET_ORG_CONTEXT establishes the Multi-Org (MO) context for the operating unit in which settlement is processed, ensuring the correct ledger and organization are in scope.
• Settlement initiation and automation: START_SETTLEMENT begins the settlement process for a claim; CHECK_AUTO_SETL_PROCESS determines whether the automatic settlement process is applicable; CHECK_CLAIM_CLASS validates the claim's classification to confirm it is eligible for the requested settlement path.
• Validation: CHECK_PROMO_CLAIM verifies that the claim qualifies as a promotion-related claim; CHECK_PAYMENT_METHOD validates the payment method against allowable values before settlement proceeds.
• Document and instruction preparation: PREPARE_DOCS, PREPARE_INSTRUCTIONS, UPDATE_DOCS, and CREATE_SETTLE_DOC assemble and persist the settlement documentation and payment instructions that record the agreed resolution.
• Claim lifecycle: CLOSE_CLAIM finalizes the claim upon successful settlement; INCOMPLETE_CLAIM handles claims that cannot be fully settled; RESET_STATUS returns a claim or settlement to a prior state for reprocessing.
• Accounting and payment: CREATE_GL_ENTRIES and REVERT_GL_ENTRIES generate and reverse the General Ledger journal entries associated with settlement; CREATE_PAYMENT creates the payment record through the AR/payment sub-process.
• Notifications and error handling: SET_REMINDER schedules or sets reminders related to outstanding settlement actions; HANDLE_ERROR centralizes error capture and message propagation via FND_MSG_PUB.

Tables Accessed

The package reads and writes across claim, settlement, receivables, and reference tables:

• Claim tables: OZF_CLAIMS, OZF_CLAIMS_ALL (the Multi-Org master), and OZF_CLAIM_LINES store the claim header, organization-specific claim data, and line detail being settled.
• Settlement documents: OZF_SETTLEMENT_DOCS holds the settlement documentation records created and updated by this package — the object most closely associated with the user's search term ozf_settlement_docs.
• Receivables tables: AR_ADJUSTMENTS, AR_PAYMENT_SCHEDULES, and AR_RECEIVABLE_APPLICATIONS are used to apply credits, create adjustments, and settle open receivables balances.
• Party and customer reference: HZ_PARTIES, HZ_CUST_ACCOUNTS, and HZ_CUST_SITE_USES provide customer identity, account, and site information.
• Sales and resource reference: JTF_RS_RESOURCE_EXTNS and JTF_RS_SALESREPS identify the sales representatives associated with claims.
• Units of measure: MTL_UNITS_OF_MEASURE supports claim line quantity references.
• Security and organization: FND_USER and HR_ALL_ORGANIZATION_UNITS resolve the current user and operating unit context.

Usage Notes

OZF_AR_SETTLEMENT_PVT is an internal engine. It is not called directly by external or custom code; instead it is invoked by the public settlement API layer and by Oracle Trade Management application flows. Typical invocation points include:

• Oracle Forms (Trade Management UI): the Settlement and Claims forms call the public API, which delegates settlement processing to this private package when a user settles, closes, or resets a deduction or promotion claim.
• Concurrent programs: automated settlement and mass settlement programs use CHECK_AUTO_SETL_PROCESS and START_SETTLEMENT to drive unattended processing of eligible claims.
• Workflow: the package depends on WF_CORE, WF_DIRECTORY, and WF_ENGINE, indicating it participates in Oracle Workflow-driven settlement and approval processes.
• Accounting integration: GL entry creation and reversal route through the OZF GL interface private API, and payment creation routes through the OZF AR payment private API.

Because it is a PVT package, direct extension or modification is not supported. Customizations should target documented public APIs. The strong dependency on MO_GLOBAL and FND_GLOBAL reinforces that the organization context must be correctly initialized (via SET_ORG_CONTEXT) before any settlement activity to ensure the correct operating unit data is processed.