Search Results is_geocode_valid




Overview

ZX_R11I_TAX_PARTNER_PKG is an Oracle E-Business Suite PL/SQL package owned by the APPS schema that provides backward-compatibility and partner-facing entry points for the E-Business Tax (EBTax / ZX) engine. It belongs to the Oracle Financials family and is classified under the API classification "OTHER" in the ETRM 12.2.2 metadata. The package exposes validation and registration utilities that allow callers — typically third-party tax service providers, partner integrations, and legacy R11i user interfaces — to verify address-related tax attributes and to create service or extension registrations programmatically. The "R11I" prefix in the name indicates that the packaged APIs were originally introduced to preserve behavior from the 11i Tax Partner integration model while the underlying EBTax architecture was introduced in Release 12. The package declares AUTHID CURRENT_USER, meaning it executes with the privileges of the invoking user rather than the definer's privileges. The current header revision is 120.7.12010000.2, dated 2010/03/23.

Key Procedures and Functions

  • IS_GEOCODE_VALID — the function referenced by the user's search term. It returns a BOOLEAN indicating whether a supplied geocode is valid for a given organization and legal entity. The package documents two overloads: one requiring p_organization_id, p_legal_entity_id, and p_geocode, and a second accepting only p_geocode. The overload was introduced under Bug 5139634 because organizational unit and legal entity information may not be available at the time of address entry.
  • IS_CITY_LIMIT_VALID — mirrors IS_GEOCODE_VALID for city-limit validation, also with a two-argument-entity overload and a single-parameter overload for the same address-entry scenario.
  • TAX_VENDOR_EXTENSION — returns a BOOLEAN indicating whether the tax vendor extension applies, again with an organization/legal entity overload and a no-argument overload.
  • COPY_PTNR_TAX_LINE_BEF_UPD — copies partner tax line information prior to an update, taking a tax line identifier and returning a status. It supports update-time preservation of partner tax data.
  • COPY_TRX_LINE_FOR_PTNR_BEF_UPD — copies transaction line distribution data for a partner before update, driven by event class, update index, regime code, and tax provider ID.
  • CREATE_SRVC_REGISTN_FROM_UI — creates a service registration from the user interface given an API version, service provider, regime usage, and business flow.
  • CREATE_EXTN_REGISTN_FROM_UI — creates an extension registration from the UI, taking a code-generator flag.
  • EXECUTE_EXTN_PLUGIN_FROM_UI — executes an extension plug-in from the UI.
  • FLUSH_TABLE_INFORMATION — flushes cached table metadata information.

The package also declares error_message_tbl typed on ZX_API_PRVDR_PUB.ERROR_MESSAGES_TBL for returning structured error information.

Tables Accessed

The package references several EBTax, HR, and HZ tables through APPS synonyms. ZX_LINES and ZX_LINES_DET_FACTORS hold calculated tax line and determining-factor data manipulated during partner copy operations. ZX_API_REGISTRATIONS, ZX_API_REGISTRATIONS_S, ZX_API_CODE_COMBINATIONS, ZX_API_CODE_COMBINATIONS_S, ZX_API_OWNER_STATUSES, and ZX_EVNT_CLS_MAPPINGS support registration and event-class mapping used by the UI registration APIs. ZX_PARTY_TAX_PROFILE stores party-level tax configuration. The HZ tables — HZ_PARTIES, HZ_PARTY_SITES, HZ_CUST_ACCOUNTS, HZ_CUST_ACCT_SITES_ALL, and HZ_CUST_SITE_USES_ALL — supply address and party information needed for geocode and city-limit validation. HR_ALL_ORGANIZATION_UNITS provides organizational unit context for the organization/legal-entity overloads.

Usage Notes

ZX_R11I_TAX_PARTNER_PKG is most commonly invoked from EBTax partner-related forms and from custom partner integration code that must validate or register tax attributes without navigating the full EBTax UI. The validation functions are suited for real-time address entry validation, where the single-parameter overloads accommodate callers that do not yet have OU or LE context. The registration and plugin procedures support UI-driven service provider setup and are typically called with the current API version and structured error outputs. Because the package is referenced by seven other packages and executes AUTHID CURRENT_USER, implementers introducing custom calls should ensure the invoking schema holds the necessary privileges on the underlying APPS synonyms. The copy-before-update procedures operate within the transaction update flow and are not intended for standalone invocation outside that lifecycle.