Results for “regime_name”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

ZX_REG_REL_PUB is a public PL/SQL API package in the Oracle E-Business Tax (EBTax) module, owned by the APPS schema and classified as a PUB (public) API. Its principal business function is the maintenance and retrieval of tax regime relationships and their associated hierarchy. In Oracle EBS, tax regimes define the legal and regulatory frameworks under which taxes are calculated; regimes may be nested such that a parent regime contains one or more child regimes. This package provides the programmatic interface for creating and updating those parent-child regime relationships, for re-pointing tax authorities associated with a regime's taxes, and for querying regime details and regime hierarchy. The package is declared with AUTHID CURRENT_USER, meaning it executes with the privileges of the calling user, and it is designed to be called from other application code rather than directly from an end-user interface.

Key Procedures and Functions

The package exposes five documented procedures, and defines two public record types used to return query results.

• INSERT_REL — Creates a new parent-child relationship between tax regimes. It receives the child and parent regime identifiers together with the standard WHO audit and concurrent-program context columns (created by, creation date, last updated by, last update date, last update login, request ID, program ID, program login ID, and program application ID) and returns a status indicator.
• UPDATE_REL — Modifies an existing regime relationship. It accepts the child regime and an optional parent regime, along with the audit and concurrent-program context columns, and returns a status indicator.
• UPDATE_TAXES — Updates the tax authorities recorded against the taxes belonging to a regime. It takes the regime code, an old and a new representative tax authority identifier, and an old and a new collecting tax authority identifier, and returns a status indicator.
• GET_REGIME_DETAILS — Returns regime detail records. It accepts optional country code and tax regime code filters and returns a collection of regime records containing the regime code and regime name.
• GET_REGIME_HIERARCHY — Returns the hierarchical structure of regimes. It accepts an optional tax regime code and returns a collection of records containing the regime code, the parent regime code, and the hierarchy level.

Two record types support these queries: regime_rec (regime code and regime name) and regime_level_rec (regime code, parent regime code, and level), each with a corresponding index-by-binary_integer table type. The regime_name element is the attribute most directly associated with the user's search term.

Tables Accessed

The package operates against three base tables accessed through APPS synonyms:

• ZX_REGIME_RELATIONS — the primary table holding parent-child relationships between tax regimes; read and written by INSERT_REL and UPDATE_REL.
• ZX_REGIME_RELATIONS_S — the corresponding translation (TL) table storing regime relationship names in multiple languages; referenced when relationship data is queried or maintained.
• ZX_SCO_TAXES — stores taxes associated with a regime and their tax authority assignments; updated by UPDATE_TAXES when representative or collecting tax authorities change.

Usage Notes

ZX_REG_REL_PUB is intended for programmatic invocation rather than direct end-user execution. Typical callers include EBTax setup forms and concurrent programs that configure or migrate regime relationships, and custom extensions or conversion routines that need to build regime hierarchies in bulk. Because the package is a public API, it should be called instead of performing direct DML against ZX_REGIME_RELATIONS or ZX_SCO_TAXES, ensuring that validation and audit column population are handled consistently. Callers must supply the standard WHO and concurrent-program context parameters on the update and insert procedures, and must inspect the returned status value to determine success or failure. The getter procedures are appropriate for populating lists of values, validating regime codes, or reconstructing the regime hierarchy for downstream tax determination logic. The package is referenced by one other package within the application, indicating a measure of internal reuse within the EBTax code base.