Search Results dont_pay_flag

Overview

IBY.IBY_HOOK_DOCS_IN_PMT_T is a global temporary table in the Oracle Payments (IBY) schema, shipped as part of Oracle E-Business Suite 12.1.1 and 12.2.2. It serves as a transient staging area used by the Payments workbench and the payment processing hooks to pass documents that are candidates for inclusion in a payment batch, along with caller-supplied attributes that influence whether the document should be paid. The table is defined with a SYS$SESSION duration, which means that rows are visible only to the session that inserted them and are purged automatically at the end of that session. This design makes the object unsuitable for persistent storage, audit reporting, or cross-session batch inspection; it exists purely as working storage during a single payment run or document selection cycle.

From a heuristic Data Vault modeling perspective, this object classifies as a standalone structure. It carries no parent hub relationships defined through foreign keys and no dependent link tables within its own metadata. It behaves more like a session-scoped staging satellite keyed on the payment and payable document identifiers, transient by nature.

Key Information Stored

The table contains 30 documented columns. The most operationally significant of these are the identifying and withholding-related fields. Notably, the column DONT_PAY_FLAG is the field that the user searched for, and it drives the suppression of a payable document from the current payment cycle.

• PAYMENT_ID — associates the staged document with a specific payment record in the Payments schema.
• DOCUMENT_PAYABLE_ID — the surrogate key linking to the payable document. It forms part of the non-unique index IBY_HOOK_DOCS_IN_PMT_T_N1, together with DONT_PAY_FLAG.
• DONT_PAY_FLAG — indicates whether the document should be excluded from payment. Populated by the calling application or by hook logic during document selection.
• DONT_PAY_REASON_CODE — a short code identifying the reason for suppression (e.g., payment hold, dispute, insufficient authority).
• DONT_PAY_DESCRIPTION — free text describing the do-not-pay condition for user display.
• DOCUMENT_AMOUNT and DOCUMENT_CURRENCY_CODE — the gross amount and currency of the pay item before withholding.
• AMOUNT_WITHHELD and PAYMENT_CURR_DISCOUNT_TAKEN — amounts reduced from the payable for withholding and discount capture.
• CALLING_APP_ID and CALLING_APP_DOC_UNIQUE_REF1 through REF5 — identify the source application and provide up to five flexible reference values for the originating transaction.
• EXT_PAYEE_ID, PAYEE_PARTY_ID, PARTY_SITE_ID, and SUPPLIER_SITE_ID — identify the payee and its sites.
• ORG_ID and ORG_TYPE — the operating unit and organization context for multi-org filtering.
• INTERNAL_BANK_ACCOUNT_ID and EXTERNAL_BANK_ACCOUNT_ID — the disbursement and payee bank accounts.
• PAY_PROC_TRXN_TYPE_CODE — the transaction type used by the payment process.
• OBJECT_VERSION_NUMBER, CREATED_BY, CREATION_DATE, LAST_UPDATED_BY, LAST_UPDATE_DATE, and LAST_UPDATE_LOGIN — standard audit columns.

There is no documented unique index; the only index, IBY_HOOK_DOCS_IN_PMT_T_N1, is non-unique on DOCUMENT_PAYABLE_ID and DONT_PAY_FLAG. Consequently, DOCUMENT_PAYABLE_ID is the principal business-key candidate, while PAYMENT_ID and DOCUMENT_PAYABLE_ID together often act as the practical row identifier within a session.

Common Use Cases and Queries

The primary use case is diagnostic inspection of the current session's payment candidate set, typically performed from a SQL*Plus or SQL Developer session immediately after invoking a payment or document-selection hook. Because the table is SYS$SESSION duration, a query must run in the same session that populated it or a session that has inserted its own rows.

A common pattern is to identify documents flagged for non-payment:

• SELECT document_payable_id, dont_pay_flag, dont_pay_reason_code, dont_pay_description FROM iby.iby_hook_docs_in_pmt_t WHERE dont_pay_flag = 'Y';
• SELECT d.document_payable_id, d.document_amount, d.document_currency_code FROM iby.iby_hook_docs_in_pmt_t d WHERE d.payment_id = :p_payment_id AND d.dont_pay_flag = 'N';

Reporting scenarios include reconciling which documents were excluded from a batch and why, verifying that withholding amounts are correctly staged, and validating that calling-application references (CALLING_APP_DOC_UNIQUE_REF1..5) map back to the correct source transactions. Developers extending payment hooks frequently query this table to confirm that their custom logic has set DONT_PAY_FLAG and the associated reason fields as intended.

Related Objects

Two foreign key relationships are documented. DOCUMENT_PAYABLE_ID references IBY.IBY_DOCS_PAYABLE_ALL, the master table of payable documents in the Payments schema. EXT_PAYEE_ID references IBY.IBY_EXTERNAL_PAYEES_ALL, the external payee definition table. Additional objects of significance include the payment tables in the IBY schema (such as IBY_PAYMENTS_ALL) that carry the PAYMENT_ID value, the payable document distributions in IBY_DOCS_PAYABLE_ALL, and the payment process request structures that orchestrate hook invocation. Together these form the dependency chain through which this temporary table operates during payment processing.