Search Results get_line_tax_amount

Overview

IBY_AR_UTILS is a PL/SQL package body owned by the APPS schema that provides utility functions supporting the Oracle Payments (IBY) integration with Oracle Receivables (AR) within Oracle E-Business Suite Release 12.1.1 and 12.2.2. Its primary responsibility is to assemble and return payment, tax, and receivable-related data in XML form for downstream consumption by Oracle Payments transaction processing logic. The package is classified as "OTHER" in the ETRM repository, indicating it is an internal helper module rather than a publicly published API.

The most representative function, get_document_receivable, returns a concatenation of DocumentReceivable and DocumentReceivableCount XML elements for performance reasons. The transaction-extension-driven overload queries iby_xml_fndcpt_doc_headers_v filtered by trxn_extension_id and returns results only for capture transactions (transaction type IDs 8, 9, and 100). If the transaction type is anything else, the function returns NULL. The obsolete tangible-ID overload is stubbed and returns NULL.

Key Procedures and Functions

• GET_DOCUMENT_RECEIVABLE — Returns an XMLType document describing receivable headers and a count of receivable records for a given capture transaction. Uses XMLAgg and XMLConcat over document header records.
• GET_AUTHORIZATION_STATUS — Retrieves the authorization status associated with a payment transaction, supporting payment processing and settlement decisions.
• CALL_GET_PAYMENT_INFO — Wrapper utility that invokes payment information retrieval logic, aggregating payment details for the caller.
• GET_ORDER_FREIGHT_AMOUNT — Extracts the freight charge associated with an order, typically for order-level tax and total calculation.
• GET_ORDER_TAX_AMOUNT — Returns the aggregate tax amount at the order level.
• GET_ORDER_AMOUNT — Returns the total order amount, used in conjunction with freight and tax calculations.
• GET_LINE_TAX_AMOUNT — Returns the tax amount calculated for an individual transaction line. This is the function most frequently referenced by callers searching for "get_line_tax_amount," and it is typically used when line-level tax detail must be surfaced to payment or extension logic.
• GET_LINE_TAX_RATE — Returns the tax rate applied to a transaction line, complementing the line tax amount for reconciliation and reporting.
• GET_TRXN_REF_NUMBER2 — Retrieves a secondary transaction reference number, used for cross-referencing transactions between Payment and Receivables modules.

The ETRM metadata documents twelve total procedures and functions; the remaining entries follow similar helper patterns for amount and reference resolution.

Tables Accessed

• AR_CASH_RECEIPTS and AR_RECEIVABLE_APPLICATIONS — Source of receipt and application data for receivable document construction.
• IBY_TRXN_CORE, IBY_TRXN_SUMMARIES_ALL — Core Oracle Payments transaction tables supplying transaction type, instrument type, and extension identifiers.
• IBY_FNDCPT_TX_EXTENSIONS, IBY_FNDCPT_TX_OPERATIONS — Transaction extension and operation records.
• IBY_FNDCPT_SYS_CC_PF_B, IBY_FNDCPT_SYS_DC_PF_B, IBY_FNDCPT_SYS_EFT_PF_B and the corresponding IBY_FNDCPT_USER_*_PF_B tables — System- and user-level payment format profile definitions for credit card, debit card, and EFT instruments.
• IBY_AR_DOC_HEADER_GT — Global temporary table used to stage document headers during XML assembly.

PLITBLM (the standard PL/SQL index-by table type synonym) and XMLTYPE are referenced as datatype support objects.

Usage Notes

IBY_AR_UTILS is invoked internally by Oracle Payments processes rather than directly by end users. It is referenced by seven other packages within the ETRM dependency graph, confirming its role as a shared utility layer. Typical invocation paths include Oracle Payments concurrent programs that build receivable documents during capture and settlement, payment processing workflows that require tax and freight breakdowns, and Oracle Receivables integration routines that reconcile payment transactions against receipts.

Because the module is not classified as a published API, customizations should avoid direct calls to these functions; the prescribed integration surface is the Oracle Payments public API set. Organizations requiring line-level tax information—such as implementations that reported or extended get_line_tax_amount—should source that value through the supported transaction extension framework or the Receivables tax engine rather than depending on this internal package. Behavior is consistent across 12.1.1 and 12.2.2, as the header date of the source (2008) predates both releases and the object remains stable. Care should be taken to confirm that only supported transaction types are passed to get_document_receivable, since unsupported types return NULL silently.