Search Results get_awt_amount

Overview

JE_IL_TAX_PKG is a PL/SQL package owned by APPS in the Oracle E-Business Suite, declared with AUTHID CURRENT_USER. Its name and internal comments associate it with Israeli localizations of withholding tax and invoice-level tax reporting within the Oracle Payables and E-Business Tax (ZX/AP) footprint, referenced here under the JE (Oracle E-Business Tax / Payables) module prefix. The package serves as the server-side engine behind a report-oriented data extraction process, assembling amounts such as gross invoice value and withholding tax (AWT) amounts, and driving the selection and formatting of report output on Behalf of a concurrent report or an Oracle Reports definition.

Its structure is typical of a report-support package: public package-level variables hold the runtime parameters supplied by the report (period ranges, vendor type, legal entity, ledger, ordering, information and name levels, report flags, payer position, vendor name/site, report name, year, supplier number ranges, and the include-withholding-zero flag), while a small set of functions returns the computed values the report requires.

Key Procedures and Functions

The documented program units (seven in total) are:

• BeforeReport — the standard Oracle Reports package function invoked before the report's main query executes. It performs initialization and validation of the parameter values held in the package-level variables, returning a BOOLEAN to signal success or failure.
• IS_NUMBER — a utility function that accepts two string arguments and returns a VARCHAR2, used to validate whether a supplied value represents a valid number. It is typically called to guard numeric parameter input before further processing.
• GET_GROSS_AMOUNT — computes and returns the gross amount for a given invoice/check combination over a date range, taking a void-flag argument into account. It is the core monetary calculation routine for the report.
• GET_AWT_AMOUNT — returns the withholding tax (AWT) amount, reading from the package-level global variable gn_awt_amount, which is populated during the report's processing.
• GET_INVOICE_ID — returns the current invoice identifier held in the package-level global gn_invoice_id. In the context of the ETRM search term "get_invoice_id" and its alias GET_AWT_AMT, this function is the accessor through which the report obtains the invoice ID currently in scope.
• GET_AWT_AMT — an additional documented routine that returns the withholding tax amount, complementing GET_AWT_AMOUNT in the report's amount-retrieval logic.
• GET_AWT_BANK_AMT — returns the withholding tax amount applicable to the bank/payment side of the transaction, used for reconciliation of withheld amounts against payments.

No parameter lists beyond those visible in the source excerpt are asserted here; the documented descriptions are limited to purpose.

Tables Accessed

The package reads Oracle Payables, Subledger Accounting, and General Ledger data through APPS synonyms. AP_INVOICES_ALL and AP_INVOICE_DISTRIBUTIONS_ALL supply invoice headers and distribution lines; AP_CHECKS_ALL and AP_INVOICE_PAYMENTS_ALL supply payment and check information needed to compute withheld amounts at the payment level. XLA_AE_HEADERS, XLA_AE_LINES, and XLA_DISTRIBUTION_LINKS provide the Subledger Accounting entries and their linkage back to source distributions, enabling tax/withholding amounts to be traced through accounting. GL_LEDGERS and GL_LEDGER_RELATIONSHIPS resolve the ledger and its relationships for reporting by legal entity and ledger. PLITBLM is used as a PL/SQL index-by table (typically a character buffer used for report output or temporary storage of report lines).

Usage Notes

JE_IL_TAX_PKG is invoked from the Oracle Reports runtime as the report's supporting package: BeforeReport is called automatically during report initialization, while the remaining functions are called from report formulas, group filters, or query columns. It is not referenced by any other documented package, indicating a self-contained, report-specific role rather than a general-purpose API. In EBS 12.1.1 and 12.2.2, it executes under APPS with AUTHID CURRENT_USER, so callers require appropriate grants on the underlying AP, XLA, and GL objects. Customizations should not be made directly to the shipped package; use a copy in a custom schema or an event-based extension instead, since patches touching the file header may overwrite local changes.