Results for “document_header”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

IBY_XML_FNDCPT_DOC_HEADER_V is an Oracle EBS Payments (IBY) view owned by the APPS schema. Its purpose is to present payment document header information in an XML-encoded form suitable for outbound integration with external payment systems, funds capture processors, and clearinghouse interfaces. Rather than returning rows of scalar columns, the view uses Oracle XML SQL functions to construct an XMLTYPE payload whose root element is DOCUMENTRECEIVABLE. Each row produced by the view corresponds to a single receivable document header, assembled into a nested XML fragment describing document identifiers, status, dates, amounts, charges, discounts, and taxes. Because the view emits XML directly, it is typically consumed by concurrent programs or PL/SQL routines that stream the result to the funds capture processor, rather than by ad hoc reporting queries.

Underlying Base Objects

The documented view text draws its header attributes from an alias INV_HEADER (the receivables document header source), while the 12.2.2 metadata lists the following referenced objects: ARP_TRX_LINE_UTIL (package), AR_DOCS_RECEIVABLES_V (view), HZ_LOCATIONS (synonym), IBY_TRXN_CORE (synonym), IBY_TRXN_SUMMARIES_ALL (synonym), IBY_XML_FNDCPT_DOC_LINE_V (view), XMLAGG (synonym), AGGXMLIMP and XMLTYPE (types). AR_DOCS_RECEIVABLES_V supplies the receivable document data, IBY_TRXN_CORE and IBY_TRXN_SUMMARIES_ALL provide the IBY transaction core and summary attributes, and HZ_LOCATIONS supplies party location context. IBY_XML_FNDCPT_DOC_LINE_V is the companion view that produces the line-level XML, aggregated into the header fragment via XMLAGG. The ARP_TRX_LINE_UTIL package and the AGGXMLIMP/XMLTYPE types support the XML aggregation and construction. The header view therefore sits atop the receivables document model plus the IBY transaction model.

Key Columns

The view exposes a single XML-typed column (typically XML_DATA) rather than discrete relational columns. The XML structure it produces includes the following elements:

• DOCUMENTID — the calling application's document reference number (CALLING_APP_DOC_REF_NUMBER).
• DOCUMENTSTATUS — a CODE/MEANING pair; in this view both are emitted as NULL.
• DOCUMENTDATE and DOCUMENTCREATIONDATE — formatted as ISO timestamps using the 'YYYY-MM-DD"T"HH24:MI:SS' mask.
• DOCUMENTTYPE — CODE (DOCUMENT_TYPE) with a NULL MEANING.
• TOTALDOCUMENTAMOUNT — VALUE (DOCUMENT_AMOUNT) with CURRENCY CODE (DOCUMENT_CURRENCY_CODE).
• PAYMENTAMOUNT — VALUE (SETTLEMENT_AMOUNT).
• CHARGE — freight AMOUNT and CHARGETYPE 'FREIGHT'.
• DISCOUNT — DISCOUNT_AMOUNT with a NULL DISCOUNTTYPE.
• TAX — one element for local plus national tax (TAXTYPE 'SALESTAX') and one for VAT (TAXTYPE 'VAT').

Common Use Cases and Queries

The view is used principally in funds capture and receivables-to-payment integration flows, where the XML fragment is embedded in an outbound message. Because the output is XML, queries typically extract values with XML functions. A representative query is:

• SELECT XML_DATA FROM APPS.IBY_XML_FNDCPT_DOC_HEADER_V;
• SELECT x.* FROM APPS.IBY_XML_FNDCPT_DOC_HEADER_V v, XMLTABLE('/DOCUMENTRECEIVABLE' PASSING v.XML_DATA COLUMNS documentid VARCHAR2(100) PATH 'DOCUMENTID', totalamount VARCHAR2(100) PATH 'TOTALDOCUMENTAMOUNT/VALUE') x;

Such queries are useful for validating the generated payload, extracting the document identifier or total amount for reconciliation, and troubleshooting integration failures. Direct use in high-volume reporting is discouraged because XML construction carries CPU overhead relative to querying the underlying receivables and IBY transaction tables directly.