Search Results settle_claim

Overview

OZF_CLAIM_SETTLEMENT_PVT is an Oracle EBS private (PVT) PL/SQL package owned by APPS that belongs to the Trade Management (formerly Oracle Claims and Funds) product family. It encapsulates the settlement-processing logic used by the Oracle Trade Management application to resolve customer claims against transactions, budgets, and funds. Claims in Trade Management represent customer requests for credit or reimbursement relating to promotions, accruals, or deduction activity; the settlement package is the component that validates the claim against the source transaction, applies the settlement, and optionally completes the settlement record.

The package is classified as PVT, indicating it is intended as an internal implementation layer rather than a public, documented API. It is declared with AUTHID CURRENT_USER and operates on the OZF schema objects through APPS synonyms. Referenced by five other packages, it forms part of the core claim lifecycle infrastructure used by the Trade Management HTML/Forms user interface and concurrent settlement processing.

Key Procedures and Functions

• CHECK_TRANSACTION_BALANCE — Determines whether the balance of the original transaction has changed since the claim was created. This is the procedure most commonly associated with the search term "check_transaction_balance". It accepts the customer transaction identifier, the claim amount, and the claim number, and returns a status indicator through an OUT parameter. It is typically used before settlement to detect stale or altered transaction balances that would invalidate the claim.
• COMPLETE_SETTLEMENT — Performs completion of a settlement record. It follows the standard EBS API convention with p_api_version, p_init_msg_list, p_commit, and p_validation_level parameters, and returns x_return_status, x_msg_data, and x_msg_count. It operates on the claim record type defined in OZF_CLAIM_PVT and returns the updated claim record.
• SETTLE_CLAIM — Drives the settlement of a claim. It uses the same standard API parameter pattern as COMPLETE_SETTLEMENT. The header history notes an original creation date of 10-AUG-2001. This procedure orchestrates the settlement workflow for a claim.
• RAISE_BUSINESS_EVENT — Publishes a business event related to claim settlement, enabling integration with Oracle Workflow and the Business Event System for downstream subscribers.
• CLAIM_APPROVAL_REQUIRED — Evaluates whether a claim requires approval, supporting the approval-routing behavior configured within Trade Management.

Tables Accessed

The package reads and writes a broad set of claim, transaction, and setup tables through APPS synonyms:

• OZF_CLAIMS, OZF_CLAIMS_ALL — The primary claim headers that are being settled.
• OZF_CLAIM_LINES, OZF_CLAIM_LINES_ALL, OZF_CLAIM_LINES_UTIL, OZF_CLAIM_LINES_UTIL_ALL — Claim line detail and the corresponding utilization records that track how claim amounts consume budgets and funds.
• OZF_SETTLEMENT_DOCS — Settlement documents created or updated during settlement.
• OZF_FUNDS_UTILIZED_ALL_B — Fund utilization balances affected by the settlement.
• AR_PAYMENT_SCHEDULES, AR_PAYMENT_SCHEDULES_ALL — Receivables payment schedules used to evaluate and adjust the original transaction balance.
• HZ_CUST_ACCOUNTS — Customer account information associated with the claim.
• OZF_CUST_TRD_PRFLS, AMS_CUSTOM_SETUP_ATTR — Customer trade profiles and setup attributes that drive approval and settlement rules.
• OZF_SYS_PARAMETERS, OZF_SYS_PARAMETERS_ALL — System parameters controlling Trade Management behavior.

Usage Notes

OZF_CLAIM_SETTLEMENT_PVT is invoked internally by the Trade Management application layer rather than directly by end users. Typical callers include Trade Management claim and settlement forms, concurrent settlement programs, and other OZF packages (it is referenced by five packages). The COMPLETE_SETTLEMENT and SETTLE_CLAIM procedures should be called with a valid API version and, where transactional control is desired, with p_commit set appropriately by the calling program.

CHECK_TRANSACTION_BALANCE is commonly used as a pre-settlement validation step to confirm that the underlying Receivables transaction balance has not changed. Custom extensions should treat this package as private and, where possible, invoke the corresponding public OZF claim APIs instead of calling these procedures directly, since the signature is subject to change across releases. All operations are subject to standard EBS message-stack handling via FND_API, and callers should always inspect x_return_status and the message count/data outputs.