Search Results pay_by_write_off

Overview

OZF_AR_PAYMENT_PVT is an Oracle E-Business Suite PL/SQL package owned by the APPS schema and classified as a private (PVT) API within the Oracle Trade Management (formerly Oracle Incentive Compensation / Channel Revenue Management) module family. Its primary business function is to manage the settlement of trade management claims, deductions, and disputes against Oracle Receivables (AR) transactions. The package bridges the OZF claim and settlement subsystem with the AR sub-ledger by creating, applying, and reversing payment-related transactions such as receipts, credit memos, chargebacks, write-offs, and adjustments.

The private designation indicates that the package is intended for internal use by other OZF packages rather than for direct invocation by external or customer code. The ETRM metadata confirms it is a VALID object in the 12.1.1 and 12.2.2 releases and that it participates actively in the trade management settlement flow.

Key Procedures and Functions

The package exposes nineteen documented procedures and functions. These can be grouped by their settlement role:

• AR transaction creation: CREATE_AR_PAYMENT, CREATE_AR_CREDIT_MEMO, and CREATE_AR_CHARGEBACK generate the corresponding AR documents that represent the financial outcome of a claim.
• Application and matching: APPLY_ON_RECEIPT, APPLY_ON_ACCOUNT_CREDIT, APPLY_CLAIM_INVESTIGATION, and UNAPPLY_FROM_RECEIPT apply or reverse amounts against receipts and on-account credits, and support investigation workflows.
• Dispute handling: UPDATE_DISPUTE_AMOUNT and UNAPPLY_CLAIM_INVESTIGATION maintain dispute balances and investigation state.
• Payment by method: PAY_BY_INVOICE_CREDIT, PAY_BY_CREDIT_MEMO, PAY_BY_ON_ACCOUNT_CREDIT, PAY_BY_CHARGEBACK, PAY_BY_WRITE_OFF, PAY_BY_DEBIT_MEMO, PAY_BY_CONTRA_CHARGE, and PAY_BY_RMA_INV_CM each implement a specific claim settlement method, driving the appropriate AR adjustment or application.
• Supporting utilities: QUERY_CLAIM retrieves claim data, CREATE_AR_WRITE_OFF creates write-off adjustments, and PROCESS_SETTLEMENT_WF submits or advances the settlement workflow.

No parameter lists are documented in the ETRM extract; callers should reference the packaged declarations for exact signatures.

Tables Accessed

The package operates against both AR and OZF tables through APPS synonyms:

• AR tables: AR_CASH_RECEIPTS, AR_PAYMENT_SCHEDULES and AR_PAYMENT_SCHEDULES_ALL, AR_RECEIVABLE_APPLICATIONS and AR_RECEIVABLE_APPLICATIONS_ALL, and AR_ADJUSTMENTS are read and written to create receipts, apply amounts, and post adjustments.
• OZF tables: OZF_CLAIMS / OZF_CLAIMS_ALL, OZF_CLAIM_LINES / OZF_CLAIM_LINES_ALL, OZF_CLAIM_TYPES_ALL_B, OZF_REASON_CODES_ALL_B, and OZF_SYS_PARAMETERS / OZF_SYS_PARAMETERS_ALL hold the claim, line, type, reason, and system parameter data that drive settlement logic.
• Common tables: GL_PERIOD_STATUSES is consulted to validate that the relevant accounting period is open before posting.

Usage Notes

Because OZF_AR_PAYMENT_PVT is a private package, it is normally invoked indirectly through its dependent packages. The ETRM metadata shows it is referenced by OZF_AR_SETTLEMENT_PVT, OZF_CLAIM_SETTLEMENT_PVT, OZF_CLAIM_TAX_PVT, OZF_MASS_SETTLEMENT_PVT, and OZF_SETTLEMENT_DOC_PVT. These callers are triggered from Trade Management settlement and claim dispute forms and from concurrent programs that process mass settlements. It also references AR_CREDIT_MEMO_API_PUB, FND_API, and OZF_CLAIM_PVT, confirming its role as a middleware layer between OZF claim logic and the public AR APIs. Custom code should prefer the public AR and OZF APIs rather than calling OZF_AR_PAYMENT_PVT directly, as private signatures may change without notice across patches and upgrades.