Search Results zx_api_prvdr_pub




Overview
Explore in AI Chat

Overview

ZX_API_PRVDR_PUB is a public PL/SQL package in the APPS schema that manages the registration, deregistration, and execution of external tax service providers within Oracle E-Business Suite. It forms part of the ETRM (E-Business Tax) module infrastructure, which allows third-party tax calculation engines and tax content providers to integrate with the E-Business Tax determination and calculation framework. The package acts as an API gateway through which a service provider is enrolled for a specific service type, country, and business flow, then invoked at runtime to perform its tax-related processing.

The package is classified as a PUB (public) API, meaning it is intended for supported external invocation by integrators and custom code rather than internal use only. It exposes strongly typed error reporting through a PL/SQL collection, allowing callers to inspect detailed diagnostic messages after each operation.

Key Procedures and Functions

  • CREATE_SRVC_REGISTRATION — Registers a tax service provider for a given service type, country, and business flow. It records the provider's identifying name, the service type code it supports, the applicable country, and the business flow context, along with the package and procedure names that implement the provider's logic. The procedure returns a status and a table of error messages.
  • DELETE_SRVC_REGISTRATION — Removes a previously created service provider registration. It identifies the registration by service provider name, service type code, country code, and business flow. This is used when a provider is retired or its configuration is superseded.
  • EXECUTE_SRVC_PLUGIN — Invokes the registered plug-in logic for a named service provider. This is the runtime entry point through which the provider's own code is executed within the tax processing cycle. It returns the outcome status and any error messages generated during execution.

The package additionally defines the ERROR_MESSAGES_TBL type, a PL/SQL associative array of VARCHAR2(1000) indexed by BINARY_INTEGER. This user-defined type is the standard vehicle for returning one or more diagnostic messages to the calling program, and it is the object most commonly referenced when developers search for error_messages_tbl in association with this package.

Tables Accessed

The package interacts with a set of configuration and party-related tables, all addressed through APPS synonyms:

Usage Notes

ZX_API_PRVDR_PUB is typically invoked from E-Business Tax configuration forms, concurrent programs, and custom integration code when onboarding or executing a third-party tax service provider. Because the procedures expose an API version parameter, callers should pass the supported version and always inspect X_RETURN_STATUS before consuming results. Error conditions are surfaced both through the return status and the X_ERROR_MSG_TBL collection, so robust callers iterate over that table to log or display messages. At least one other package references ZX_API_PRVDR_PUB, indicating it participates in a broader tax integration call chain rather than being invoked in isolation. Customizations should treat the package as a supported public interface and avoid direct DML against the underlying ZX_API tables.