Search Results process_withholding_type

Overview

JL_ZZ_AP_WITHHOLDING_PKG is a Latin American localization (JL schema) PL/SQL package owned by APPS and shipped in Oracle E-Business Suite 12.1.1 and 12.2.2. It implements the withholding tax processing logic associated with Oracle Payables for jurisdictions that levy amount withheld at payment (AWT) or at invoice time. The package carries the header identifier jlzzpwhs.pls 120.8, indicating it is a localized extension rather than a core Payables object. Its role is to determine which withholding types, tax names, and rates apply to a given invoice or invoice distribution, compute the taxable base and the withheld amount, apply proration across distributions, and persist the calculated withholding details so that downstream Payables and General Ledger processes can account for them.

The package defines several PL/SQL record structures that model the withholding domain, notably Rec_Withholding, Rec_All_Withholding, and Rec_AWT_Code. These records capture invoice and distribution identifiers, withholding type and jurisdiction codes, tax identifiers and code combinations, period types, rates, line and taxable base amounts, revised tax bases, withheld and prorated amounts, exemption amounts, and applicability flags. Constants such as AWT_SUCCESS and AWT_ERROR provide standardized return statuses to callers.

Key Procedures and Functions

The package exposes nineteen documented procedures and functions that collectively drive the withholding calculation lifecycle:

• GET_WITHHOLDING_OPTIONS — retrieves the withholding configuration and options applicable to the current processing context.
• GET_GL_PERIOD_NAME — resolves the General Ledger period name associated with a transaction, used to align withholding to the correct accounting period.
• GET_BASE_CURRENCY_CODE — returns the base (functional) currency code required for amount conversions and comparisons.
• INITIALIZE_WITHHOLDING_TABLE, INITIALIZE_WITHHOLDING_TYPE, INITIALIZE_WITHHOLDING_NAME — initialize the internal working structures for the withholding table, type, and tax name respectively before processing begins.
• GET_TAXABLE_BASE_AMOUNT — computes the base amount against which withholding is assessed for an invoice or distribution.
• STORE_TAX_NAME, PROCESS_WITHHOLDING_NAME — store and process withholding tax name details, including code combination and rate attributes.
• PRORATE_WITHHOLDINGS, STORE_PRORATED_WITHHOLDINGS — allocate the total withholding across invoice distributions and persist the prorated results.
• STORE_INTO_TEMPORARY_TABLE — stages intermediate withholding results in a temporary structure prior to final persistence.
• PROCESS_WITHHOLDING_TYPE — the central routine that evaluates and applies withholding for a specific withholding type, orchestrating base calculation, rate lookup, and amount derivation.
• PRINT_TAX_NAMES — outputs or reports the tax names resolved during processing for debugging and audit purposes.
• JL_ZZ_AP_EXTENDED_MATCH, JL_ZZ_AP_EXT_INSERT_DIST — support extended matching and insertion of distribution-level withholding records.
• VALIDATE_MULTIPLE_BAL_SEG, VALIDATE_MULT_BS_GATEWAY, DYNAMIC_CALL_GET_BALSEG — validate balancing segment configurations and dynamically obtain the appropriate balancing segment value, typically where multiple balancing segments or localization-specific segment rules apply.

Tables Accessed

The package reads and writes a defined set of Payables and localization tables through APPS synonyms. Invoice and distribution data are sourced from AP_INVOICES, AP_INVOICE_DISTRIBUTIONS, and the interface tables AP_INVOICES_INTERFACE and AP_INVOICE_LINES_INTERFACE. Withholding configuration is drawn from JL_ZZ_AP_AWT_TYPES, JL_ZZ_AP_SUPP_AWT_TYPES, JL_ZZ_AP_SUP_AWT_CD, AP_AWT_TAX_RATES, and AP_TAX_CODES. Calculated withholding buckets are held in AP_AWT_BUCKETS and the localization detail tables JL_ZZ_AP_INV_DIS_WH and JL_ZZ_AP_INV_DIS_WH_S. Period and system context come from AP_OTHER_PERIODS, GL_PERIOD_STATUSES, and AP_SYSTEM_PARAMETERS.

Usage Notes

JL_ZZ_AP_WITHHOLDING_PKG is invoked primarily from Oracle Payables invoice and payment processing, including the Invoice Workbench forms and withholding-related concurrent programs that apply localized withholding during invoice validation and payment. It is also referenced by four other packages in the EBS codebase, indicating it is a shared localization service. Customizations and extensions calling this package directly should respect the documented procedure names and record structures, avoid assuming parameter signatures not present in the shipped specification, and account for the fact that the object is a localization component — its behavior depends on the Latin American withholding setup and may not be active in all EBS installations. Callers should rely on the AWT_SUCCESS and AWT_ERROR constants for status evaluation.