Search Results global_document_update

Overview

ZX_VERTEX_TAX_SERVICE_PKG is the Oracle E-Business Tax (EBTax) integration package that brokers communication between Oracle EBS applications and the Vertex indirect tax calculation engine. In Release 12.1.1 and 12.2.2, EBTax replaced the legacy 11i tax engines with a centralized tax repository, and third-party tax providers such as Vertex are invoked through a defined partner interface. This package implements the Vertex-specific side of that interface: it assembles the tax request data, invokes the external service, and maps the returned jurisdiction, rate, and tax line results back into EBTax structures.

The package is owned by APPS and is classified as an OTHER API, indicating it is an internal service package rather than a public, fully supported integration API. It is referenced by one other package, and its declarations expose only three procedures, all operating on shared partner data structures defined in ZX_TAX_PARTNER_PKG.

Key Procedures and Functions

• CALCULATE_TAX_API — The primary tax calculation entry point. It accepts currency and tax line input structures and returns calculated tax lines together with an error status and a message table. This procedure carries the request through to Vertex and returns detailed tax results to the calling EBTax flow.
• SYNCHRONIZE_VERTEX_REPOSITORY — Reconciles the local EBTax tax configuration with the tax content maintained in the Vertex repository. It returns synchronization output lines, a return status, and messages, allowing administrators to align jurisdictions, regimes, and rates with the provider's reference data.
• GLOBAL_DOCUMENT_UPDATE — Processes document-level updates submitted across the tax partner interface, taking a transaction record and returning a status and message table. This is the routine associated with the search term "global_document_update," and it supports provider-side updates that must be reflected on tax documents originating in EBS.

All three procedures use NOCOPY OUT parameters for the status and message structures, a standard pattern for high-volume EBTax partner calls.

Tables Accessed

The package reads and writes EBTax configuration and staging tables through APPS synonyms. Core tax setup objects include ZX_REGIMES_B, ZX_JURISDICTIONS_B, ZX_EVNT_CLS_MAPPINGS, and ZX_TAX_VERTEX_QSU, the latter holding Vertex question-set-up mappings. Transaction and result data flow through ZX_LINES and ZX_DETAIL_TAX_LINES_GT, with ZX_LINES_DET_FACTORS supplying determining-factor values used to derive tax applicability rules.

Geographic and partner resolution relies on HZ_LOCATIONS, ZX_PTNR_LOCATION_INFO_GT, ZX_TAX_VERTEX_GEO, and ZX_JURISDICTIONS_GT. Provider-specific request and response payloads are staged in ZX_PRVDR_HDR_EXTNS_GT and ZX_PRVDR_LINE_EXTNS_GT, while negative or exception outcomes are written to ZX_PTNR_NEG_LINE_GT and ZX_PTNR_NEG_TAX_LINE_GT.

Usage Notes

ZX_VERTEX_TAX_SERVICE_PKG is not intended for direct invocation from custom code. It is called internally by the EBTax tax determination and partner integration flows, typically when a transaction is saved or a Calculate Tax action is performed in a form, or when tax calculation is run through a concurrent program during order, invoice, or return processing. Administrators trigger repository synchronization as part of maintaining Vertex tax content, while document updates are processed through the partner framework. Because the API classification is OTHER, any custom extension that references these procedures risks unsupported behavior across patches and upgrades.