Search Results ap_awt_callout_pkg




Overview
Explore in AI Chat

Overview

AP_AWT_CALLOUT_PKG is an Oracle E-Business Suite PL/SQL package owned by the APPS schema that provides the integration hooks between Oracle Payables (AP) and the Oracle E-Business Tax (EBTax / ZX) withholding and payment adjustment engine. Its role is to implement the callout interface used by the Payments workbench and withholding tax processing when taxable payment activity must be passed to the tax subsystem for evaluation and adjustment.

The package is classified under the API classification category OTHER within the ETRM repository, indicating it is not a published public API but an internal callback/implementation hook invoked by the tax engine rather than by end-user code. It is a member of the Automatic Withholding Tax (AWT) callout infrastructure in Payables. The package is designated VALID in the documented releases (12.1.1 and 12.2.2), confirming its availability across both the pre-12.2 and multi-organization-enabled (MOAC) 12.2.x architectures.

Key Procedures and Functions

The ETRM documentation records two callable entry points within AP_AWT_CALLOUT_PKG:

  • ZX_PAYMENTSADJUSTHOOK — This procedure serves as the hook called by the E-Business Tax engine when a payment-related tax adjustment must be applied. It allows Payables withholding and payment adjustment logic to be executed in response to a tax determination or recalculation event raised against a payment. The tax engine invokes it during the payment adjustment phase of withholding tax processing.
  • ZX_WITHOLDINGCERTIFICATESHOOK — This procedure is the callout invoked in the context of withholding certificates. It supports the tax engine in evaluating or applying withholding certificate information to determine the appropriate withholding rate or adjustment for a supplier or supplier site. It is executed when withholding certificate data must be consulted during tax calculation for AWT.

Both routines are callback-style implementation routines; they are named with the ZX prefix to designate them as E-Business Tax hooks rather than user-facing APIs. Parameter lists are not enumerated in the ETRM metadata and should be confirmed against the package specification in the target instance before direct invocation.

Tables Accessed

The package accesses the following documented tables through APPS synonyms:

  • IBY_HOOK_DOCS_IN_PMT_T — An Oracle Payments (IBY) hook structure table that carries documents-in-payment information into the tax callout. AP_AWT_CALLOUT_PKG reads the payment document context supplied by Payments to determine which payments are subject to tax evaluation.
  • IBY_HOOK_PAYMENTS_T — The corresponding IBY hook table for payment-level records. It supplies the payment attributes (such as payment identifiers and withholding-relevant data) required by the callout routines to compute or apply the tax adjustment.

These tables are hook staging structures rather than persistent transactional tables; they are populated by Oracle Payments before invoking the AP withholding and tax callout, and consumed by AP_AWT_CALLOUT_PKG during processing.

Usage Notes

AP_AWT_CALLOUT_PKG is not intended for direct invocation by custom code or concurrent programs. It is executed implicitly by the Oracle E-Business Tax and Oracle Payments callout framework when a payment requires withholding certificate evaluation or payment adjustment, most commonly during the Payables Payment Workbench payment creation and confirmation flow and during withholding tax recalculation. The package references STANDARD (the PL/SQL STANDARD package) and is referenced within the APPS schema itself. ETRM records no other packages as dependent on it, further confirming its position as a leaf-level implementation hook. Sites implementing Automatic Withholding Tax should ensure withholding tax configuration, E-Business Tax setup, and Payments options are correct, since the callouts depend on those configurations. Any modification or extension should be performed through supported tax setup rather than by altering this package.