Search Results clear_ebt_gt

Overview

ARP_ETAX_UTIL is a utility package in the Oracle E-Business Suite Receivables (AR) module, owned by the APPS schema and classified as a UTIL-type API within ETRM documentation. Its primary business function is to centralize the shared logic required to calculate, validate, store, and post international and domestic transaction taxes on Receivables documents. It acts as the common tax engine used across a wide range of AR flows, including invoices, credit memos, adjustments, receipts, cashbooks, allocation, and autoinvoice processing.

Because tax rules vary by country, legal entity, tax classification, and customer site, the package encapsulates the reusable routines that determine tax applicability, compute tax amounts, and generate the corresponding tax distribution lines. By isolating this logic, ARP_ETAX_UTIL allows dozens of calling packages to invoke a single, consistent tax calculation path. The package is dependent on ARP_ACCT_MAIN and standard SYS constructs, and it is referenced by at least 21 other AR packages, confirming its role as a foundational dependency in the Receivables tax architecture.

Key Procedures and Functions

The documented interface exposes 21 procedures and functions that fall into several functional groupings.

• Tax validation and calculation: VALIDATE_TAX_INT and VALIDATE_FOR_TAX perform tax applicability and validity checks, while CALCULATE_TAX_INT executes the core tax computation. ADJUST_FOR_INCLUSIVE_TAX handles taxes embedded within unit prices, and TAX_CURR_ROUND applies currency-appropriate rounding.
• Tax line generation and maintenance: BUILD_AR_TAX_LINES constructs the tax distribution lines for a transaction, and DELETE_TAX_LINES_FROM_AR removes existing tax lines before recalculation. GET_TAX_ACCOUNT resolves the account to which tax amounts post.
• Recoverability handling: PRORATE_RECOVERABLE, SET_RECOVERABLE, and DISTRIBUTE_RECOVERABLE manage the allocation of recoverable versus non-recoverable tax portions.
• Classification and defaults: GET_DEFAULT_TAX_CLASSIFICATION and SET_DEFAULT_TAX_CLASSIFICATION retrieve and apply default tax classifications for transactions.
• Applied and remaining amounts: CALC_APPLIED_AND_REMAINING and GET_DISCOUNT_RATE support downstream calculation of applied, adjusted, and remaining balances tied to taxed documents.
• Context and event resolution: GET_COUNTRY_AND_LEGAL_ENT, GET_EVENT_INFORMATION, CLEAR_EBT_GT, SYNCHRONIZE_FOR_DOC_SEQ, and GLOBAL_DOCUMENT_UPDATE provide jurisdictional context, event data, global temporary table cleanup, and document sequencing support.

Tables Accessed

ARP_ETAX_UTIL reads and writes several core AR tables. Transaction tax lines and adjustments are maintained through AR_ADJUSTMENTS, AR_LINE_DIST_INTERFACE_GT, and AR_RECEIVABLE_APPLICATIONS (with its AR_RECEIVABLE_APPLICATIONS_S sequence-based counterpart). Payment and receipt context is drawn from AR_CASH_RECEIPTS, AR_PAYMENT_SCHEDULES, AR_RECEIPT_METHOD_ACCOUNTS, and AR_RECEIVABLES_TRX. Customer and site information comes from HZ_CUST_ACCOUNTS and HZ_CUST_ACCT_SITES, while legal entity and organization context is obtained from HR_ALL_ORGANIZATION_UNITS. System configuration, currency, accounting, and sequencing data are supplied by AR_SYSTEM_PARAMETERS, FND_CURRENCIES, GL_CODE_COMBINATIONS, and FND_DOCUMENT_SEQUENCES.

Usage Notes

This package is not typically invoked directly by end users. Instead, it is called internally by AR transaction, adjustment, receipt, and autoinvoice processing packages, such as ARP_PROCESS_HEADER, ARP_PROCESS_ADJUSTMENT, ARP_RECEIPTS_MAIN, and the ARP_ETAX_* family. Forms and concurrent programs that create or modify Receivables transactions trigger these callers indirectly. Custom extensions that require consistent EBS tax behavior should also call ARP_ETAX_UTIL rather than reimplementing tax logic. Given its broad dependency footprint, changes to this package carry wide impact across Receivables and should be regression tested against invoicing, adjustments, and receipt processing.