Search Results p_ship_to_org_id




Overview

ZX_TCM_VALIDATE_EXEMPT_PKG is a Tax Configuration Manager (TCM) validation package in the Oracle E-Business Suite Tax (ZX) module. Its sole responsibility is to validate whether a given tax exemption certificate, identified by tax exemption number and exemption reason code, is applicable to a specific transaction context. It does not create, update, or delete exemption records; it performs read-only eligibility checks and returns a validity flag along with the standard FND_API return status, message count, and message data outputs.

The package is typically used to answer the question: "Is this exemption certificate valid for this ship-to organization, bill-to customer, legal entity, transaction type, and transaction date?" This is a common requirement in Order Management, Receivables, and Purchasing flows where an exemption must be validated before tax is calculated or waived. The presence of p_ship_to_org_id as an input parameter confirms the package supports ship-to-based exemption determination, which is central to destination-based tax rules.

Key Procedures and Functions

The package body exposes one documented public procedure:

  • VALIDATE_TAX_EXEMPTIONS — Accepts a tax exemption number and reason code together with a full transaction context (ship-to org, invoice-to org, bill-to customer account, ship-to and bill-to party sites, operating unit, bill-to party, legal entity, transaction type, batch source, transaction date, and an optional exemption status defaulting to 'P' for Pending). It returns an x_valid_flag ('Y' or 'N'), an x_return_status, plus x_msg_count and x_msg_data for error reporting. Internally it resolves the legal entity when p_legal_entity_id is null by invoking the XLE business information group, and it initializes FND logging before performing validation.

Tables Accessed

The only table documented as referenced through an APPS synonym is FND_LOG_MESSAGES. This is the Oracle Application Object Library diagnostic logging table, used here purely for instrumentation. The package records runtime messages at levels defined by FND_LOG (LEVEL_UNEXPECTED, LEVEL_ERROR, LEVEL_EXCEPTION, LEVEL_EVENT, LEVEL_PROCEDURE, LEVEL_STATEMENT) to assist debugging of exemption validation logic. The business data underlying exemption validation — exemption certificate headers, exemption lines, and their associated qualifiers — is accessed through the ZX Tax Configuration Manager schema, though only FND_LOG_MESSAGES appears in the documented table reference list.

Usage Notes

ZX_TCM_VALIDATE_EXEMPT_PKG is classified as an OTHER API rather than a public API, indicating it is intended primarily for internal ETRM/Tax engine consumption rather than direct customer invocation. It is referenced by three other packages, confirming it functions as a shared validation utility within the tax determination stack.

Typical invocation scenarios include:

  • Tax calculation engines invoked during Order Management order entry, Receivables invoice entry, or Purchasing document entry, where exemption status must be confirmed before applying a zero or reduced rate.
  • Concurrent programs that process or re-validate large volumes of exemption certificates against historical or pending transactions.
  • Custom PL/SQL extensions that must replicate standard exemption validation behavior, calling this procedure and inspecting x_valid_flag and x_return_status.

Callers must supply a complete transaction context; the package derives the legal entity only when it is not already provided. Because the procedure follows FND_API conventions, callers should always check x_return_status before acting on x_valid_flag, and should retrieve messages via FND_MSG_PUB when x_msg_count exceeds zero. The p_ship_to_org_id parameter is essential for ship-to-driven exemption rules and should never be passed as null where destination-based tax applies.