Search Results get_tax_regime




Overview
Explore in AI Chat

Overview

ZX_MIGRATE_UTIL is a utility package in the Oracle E-Business Tax (E-Business Tax / ETRM) module of Oracle E-Business Suite, owned by the APPS schema and classified as a UTIL API. It is defined with AUTHID CURRENT_USER, meaning it executes with the privileges of the calling user rather than the definer. The package provides a collection of helper routines that support data migration, upgrade, and setup activities for the tax engine. Its primary role is to resolve configuration facts at runtime — such as the applicable tax regime for a given tax type and operating unit, or the mapping between tax names and tax types — and to perform maintenance operations on tax-related setup data. Because the package is a utility rather than a public business API, its functions and procedures are largely intended for internal use by migration scripts, concurrent programs, and other E-Business Tax packages rather than direct end-user invocation.

Key Procedures and Functions

The package exposes seven documented program units:

  • GET_TAX_REGIME — Returns the tax regime applicable to a given tax type and operating unit (organization). It allows migration and setup logic to derive the correct regime context without hard-coding regime identifiers. This is the routine most frequently associated with searches for tax regime resolution.
  • GET_TAX — Returns a tax identifier or value corresponding to a supplied tax name and tax type, providing a lookup between human-readable tax names and their internal identifiers.
  • IS_INSTALLED — Returns a flag indicating whether a given product (by product code) is installed, enabling conditional migration logic based on which applications are present.
  • ZX_UPDATE_LOOKUPS — Updates E-Business Tax lookup data, taking an upgrade mode parameter. Used during upgrades or migrations to refresh lookup values.
  • ZX_ALTER_RATES_SEQUENCE — Alters the sequence associated with tax rates, typically to adjust numbering during migration or data load. This is a DDL-adjacent maintenance procedure.
  • GET_COUNTRY — Returns the country associated with a supplied operating unit, resolving geography context for tax determination.
  • GET_NEXT_SEQID — Returns the next sequence identifier for a named sequence, supporting generation of surrogate keys during data migration.

Tables Accessed

The package references a range of E-Business Tax and shared setup tables via APPS synonyms. Tax configuration tables include ZX_RATES_B (tax rates), AP_TAX_CODES_S and AR_VAT_TAX_S (legacy tax code and VAT definitions), and AR_SYSTEM_PARAMETERS_ALL and FINANCIALS_SYSTEM_PARAMS_ALL (system-level configuration used to derive operating unit and country context). Organization and location data are read from HR_ALL_ORGANIZATION_UNITS, HR_ORGANIZATION_INFORMATION, and HR_LOCATIONS_ALL. Application installation state is determined through FND_PRODUCT_GROUPS and FND_PRODUCT_INSTALLATIONS, while lookup data is maintained in FND_LOOKUP_TYPES. DUAL is used for scalar evaluations. These accesses support regime resolution, tax lookup, country derivation, and lookup/sequence maintenance.

Usage Notes

ZX_MIGRATE_UTIL is typically invoked by migration and upgrade routines rather than directly by users. It is referenced by at least fourteen other packages within E-Business Tax, indicating its role as a shared dependency. Calls are commonly made from concurrent programs and PL/SQL migration scripts during implementation or upgrade to the current release, and occasionally from forms-based setup flows that need regime or country context. Because it operates under AUTHID CURRENT_USER, the invoking session requires appropriate privileges on the underlying ZX and related tables. Custom code should treat it as an internal utility: rely on the documented return values for GET_TAX_REGIME, GET_TAX, IS_INSTALLED, GET_COUNTRY, and GET_NEXT_SEQID, exercise caution before invoking the maintenance procedures ZX_UPDATE_LOOKUPS and ZX_ALTER_RATES_SEQUENCE, and validate behavior against the target release (12.1.1 or 12.2.2) before deployment.