Results for “hz_tax_assignment_pub”

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

Overview

HZ_TAX_ASSIGNMENT_PUB is a public PL/SQL API package owned by the APPS schema in Oracle E-Business Suite releases 12.1.1 and 12.2.2. It belongs to the Oracle Receivables (AR) and Oracle Trading Community Architecture (TCA) family of APIs and exposes business logic that governs the relationship between a physical location and the tax configuration applied to it. In EBS terminology, a "location assignment" is the link between a record in HZ_LOCATIONS (a site address available to a legal entity, operating unit, or party site) and the tax attributes that determine how transactions sourced from that location are taxed. The package provides a programmatic, validated alternative to direct DML against the underlying tax-related tables, ensuring that the Tax Manager and Receivables system parameters remain consistent when a location is linked to or unlinked from a tax regime. Its header comment indicates it was last revised in 2003 under the ARHTLASS.pls source file, making it a long-standing, stable API used across multiple EBS releases.

Key Procedures and Functions

The ETRM metadata documents two public procedures:

• CREATE_LOC_ASSIGNMENT — Establishes a new tax assignment for a specified location. The caller supplies the location identifier and standard API control parameters (API version, message list initialization, commit flag, and lock flag), and the procedure returns the newly created assignment identifier through an OUT parameter along with the standard return status, message count, and message data. This is the primary entry point for integrating an external or custom process that needs to register a taxable location without duplicating the validation logic embedded in the TCA forms.
• UPDATE_LOC_ASSIGNMENT — Modifies an existing location tax assignment. Its signature mirrors CREATE_LOC_ASSIGNMENT so that callers can adopt a consistent invocation pattern; the notable distinction is the default value of the lock flag, which is set to true for update operations to protect concurrency. Both procedures raise the standard FND_API exceptions and populate the message stack for downstream error handling.

Tables Accessed

The package references four objects through APPS synonyms:

• HZ_LOCATIONS — Read to validate that the location identifier passed by the caller exists and is eligible for a tax assignment.
• HZ_PARTY_SITES — Read to confirm the site context associated with the location, since tax assignment rules can vary by party site usage.
• AR_SYSTEM_PARAMETERS — Read to retrieve Receivables system options, including the tax method and default tax configuration that influence how the assignment is created or updated.
• DUAL — Used for PL/SQL-level evaluations and simple lookups required during validation.

The metadata does not enumerate any outgoing package references, indicating that HZ_TAX_ASSIGNMENT_PUB is a leaf-level API and is not itself called by other documented packages.

Usage Notes

This package is typically invoked from the Oracle Receivables Tax Managers forms, from concurrent programs that bulk-maintain location tax assignments, or from custom PL/SQL that provisions locations during data conversion. Because the procedures expose the standard FND_API interface, callers must pass p_api_version, initialize the message list as required, and explicitly commit through p_commit when running outside a form's transaction context. The IN OUT NOCOPY change noted on x_return_status in the source header indicates that the parameter can be supplied with an initial value and re-read after the call, a pattern useful for chained API calls. As a PUBLIC API, it is supported for customer extensions, but direct DML against its underlying tables is strongly discouraged because the procedures enforce validation and concurrency controls that bypassing them would circumvent.