Search Results is_doc_to_be_recorded

Overview

ZX_VALID_INIT_PARAMS_PKG is an Oracle E-Business Tax (EBS Tax / ETRM) PL/SQL package owned by the APPS schema. Its name reflects its principal role: validating initialization parameters and providing the entry point and control logic through which tax-relevant documents are processed, recorded, calculated, and reversed within the E-Business Tax engine. The package acts as a gatekeeper for document-level tax processing, determining which transactions are eligible to enter the tax repository and orchestrating the operations that follow — tax calculation, recovery determination, distribution handling, and document reversal.

The package operates on the E-Business Tax data model, which centers on the ZX schema (tax lines, event classes, tax types, and recovery). Its scope spans the full document lifecycle, from a preliminary eligibility check (IS_DOC_TO_BE_RECORDED) through tax determination and calculation, and on to corrective operations such as overrides, deletions, and reversals. The package header declares a record type, Source_rec_Type, that captures a comprehensive set of party and party-site roles — SHIP_TO, SHIP_FROM, POA, POO, PAYING, OWN_HQ, TRAD_HQ, POI, POD, BILL_TO, BILL_FROM, TTL_TRNS, and MERCHANT — together with corresponding party-site columns. This structure supplies the taxation context for a document, indicating that the package is designed to validate and resolve the parties and sites that participate in tax determination.

The documented header includes the standard EBS header comment dated 2006, confirming this is a long-standing component of the tax infrastructure carried forward into Oracle EBS 12.1.1 and 12.2.2.

Key Procedures and Functions

The ETRM metadata lists 21 documented procedures and functions. Their purposes are as follows:

• IS_DOC_TO_BE_RECORDED — Determines whether a given document (identified by application, entity code, event class code, and quote flag) should be recorded in the tax repository.
• VALIDATE_DOCUMENT_FOR_TAX — Performs validation of a document against tax-processing requirements, verifying that the document qualifies for tax calculation. This is the function most closely associated with the search term "validate_document_for_tax."
• CALCULATE_TAX — Invokes tax calculation for a document.
• IMPORT_DOCUMENT_WITH_TAX — Imports a document together with its tax lines into the tax repository.
• OVERRIDE_TAX — Applies a user- or program-specified override to calculated tax.
• GLOBAL_DOCUMENT_UPDATE — Performs a document-wide update affecting tax attributes.
• MARK_TAX_LINES_DELETED — Flags tax lines for deletion.
• REVERSE_DOCUMENT — Reverses a previously recorded tax document.
• REVERSE_DISTRIBUTIONS — Reverses tax distributions associated with a document.
• DETERMINE_RECOVERY — Determines recoverable versus non-recoverable portions of tax.
• OVERRIDE_RECOVERY — Overrides the determined recovery values.
• FREEZE_DISTRIBUTION_LINES — Freezes distribution lines against further change.
• DISCARD_TAX_ONLY_LINES — Discards tax lines that have no corresponding transaction line.
• INSUPD_LINE_DET_FACTORS — Inserts or updates line-level tax determination factors.
• GET_DEFAULT_TAX_DET_ATTRS — Retrieves default tax determination attributes.
• DETERMINE_EFFECTIVE_DATE — Determines the effective date for tax processing.
• GET_TAX_SUBSCRIBER — Returns the tax subscriber context for an event.
• GET_TAX_EVENT_TYPE — Returns the applicable tax event type.
• POPULATE_EVENT_CLASS_OPTIONS — Populates event class options for processing.
• GET_LOC_ID_AND_PTP_IDS — Resolves location identifiers and party/party-site identifiers used as tax determination inputs.

Tables Accessed

The package references the following tables through APPS synonyms, all in the ZX tax schema:

• ZX_EVENT_CLASSES_B, ZX_EVNT_CLS_MAPPINGS, ZX_EVNT_CLS_OPTIONS, ZX_EVNT_CLS_TYPS, ZX_EVNT_TYP_MAPPINGS — define event classes, event types, class-type relationships, and their options; used to validate and resolve the event context of a document.
• ZX_LINES_DET_FACTORS — stores line-level tax determination factors read and written by INSUPD_LINE_DET_FACTORS and GET_DEFAULT_TAX_DET_ATTRS.
• ZX_TRANSACTION_LINES_GT, ZX_REVERSE_TRX_LINES_GT, ZX_REV_TRX_HEADERS_GT, ZX_REVERSE_DIST_GT — global temporary tables (GT) used as staging areas for transaction lines, reverse transaction lines, reverse transaction headers, and reverse distributions during reversal and import operations.
• DBMS_UTILITY and PLITBLM — Oracle-supplied utilities used for PL/SQL table and error/utility handling.

Usage Notes

ZX_VALID_INIT_PARAMS_PKG is an internal engine component rather than an end-user API. It is invoked indirectly by E-Business Tax processing, including the tax calculation and document import flows driven by user actions in forms and by concurrent programs that process tax for transactions such as invoices, purchase orders, and sales orders. The metadata records that the package is referenced by nine other packages, confirming its role as a shared service within the tax code base. Customizations should not call this package directly unless the calling code replicates the full event context — entity code, event class code, and the associated party and site identifiers — expected by the Source_rec structure. Because of its dependency on global temporary tables and the tax repository's referential integrity, direct calls should be limited to diagnostics or custom extensions that follow Oracle's own invocation patterns.