Results for “payment_reason_code”

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

Overview

IBY_PAYMENT_REASONS_B is the base (non-translated) table in the Oracle Payments (IBY) module of Oracle E-Business Suite 12.1.1 and 12.2.2. It stores the master list of payment reasons used as lookup values for payee records and for documents payable, that is, invoices. Functionally the table parallels the FND_LOOKUPS lookup mechanism, but adds an explicit TERRITORY_CODE column so payment reasons can be qualified by territory. Because payment reasons drive downstream payment processing, this table is referenced throughout the IBY and FV schemas wherever a reason must be captured or reported. Note that the table is a base table only; translated descriptions live in the companion IBY_PAYMENT_REASONS_TL table.

Consistent with the provided relationship metadata, the object behaves as a hub-leaning reference entity: it owns its own identity through a surrogate code and is referenced by many dependent transactional and instruction tables. In Data Vault terms, IBY_PAYMENT_REASONS_B can be modeled as a hub keyed on PAYMENT_REASON_CODE, with the descriptive attributes carried as hub satellite context.

Key Information Stored

The table contains 12 documented columns. The most significant are:

• PAYMENT_REASON_CODE — the primary key column (IBY_PAYMENT_REASONS_B_PK) and the value propagated to every foreign-key consumer. It is also the leading column of the unique index IBY_PAYMENT_REASONS_B_U1.
• ZD_EDITION_NAME — the edition-tracking column introduced for Oracle EBS 12.2.2 online patching; it forms the second column of the unique index IBY_PAYMENT_REASONS_B_U1, together with PAYMENT_REASON_CODE representing the business-key candidate in the editioned model.
• FORMAT_VALUE — the formatted/display value associated with the lookup entry.
• SEEDED_FLAG — indicates whether the reason is system-seeded or user-defined.
• TERRITORY_CODE — territory qualifier for the reason; the single documented foreign key, referencing FND_TERRITORIES.
• INACTIVE_DATE — the date from which the reason is considered inactive or no longer available for selection.
• OBJECT_VERSION_NUMBER — optimistic locking column used by the Oracle Payments APIs and concurrent programs.
• CREATED_BY, CREATION_DATE, LAST_UPDATED_BY, LAST_UPDATE_DATE, LAST_UPDATE_LOGIN — standard Oracle Applications who-columns for audit and change tracking.

The surrogate primary key is therefore the combination defined by the table's PK constraint, while payable/reason values are resolved by PAYMENT_REASON_CODE plus the edition discriminator.

Common Use Cases and Queries

Typical scenarios include validating a payment reason before it is written to a payment or instruction record, listing active reasons for a selected territory, and joining the base table to its translation table for multi-language reporting.

A representative pattern for active reasons is:

• SELECT payment_reason_code, format_value, territory_code FROM iby_payment_reasons_b WHERE inactive_date IS NULL OR inactive_date > SYSDATE;
• SELECT b.payment_reason_code, t.description FROM iby_payment_reasons_b b, iby_payment_reasons_tl t WHERE b.payment_reason_code = t.payment_reason_code AND t.language = USERENV('LANG');
• SELECT p.payment_id, p.payment_reason_code, r.format_value FROM iby_payments_all p, iby_payment_reasons_b r WHERE p.payment_reason_code = r.payment_reason_code;

Reporting use cases include segmentation of payments by reason, reconciliation of seeded versus user-defined reasons, and territory-based reason distribution analysis. Because the table is a low-volume reference object, it is frequently cached or used as a lookup in payment exception reports.

Related Objects

The following are the most significant objects that reference or depend on IBY_PAYMENT_REASONS_B, joined on PAYMENT_REASON_CODE unless noted:

• IBY_PAYMENTS_ALL and IBY_PAYMENTS_H — payments and their history, capturing the reason applied to each payment.
• IBY_PAY_INSTRUCTIONS_ALL and IBY_PAY_INSTRUCTIONS_H — payment instructions and their history, referencing the reason.
• IBY_DOCS_PAYABLE_ALL — documents payable (invoices) that carry a payment reason.
• IBY_EXTERNAL_PAYEES_ALL and IBY_TEMP_EXT_PAYEES — payee records that store a reason.
• IBY_PAYMENT_REASONS_TL — translated descriptions keyed by PAYMENT_REASON_CODE.
• FV_PB_SEQ_ASSIGNMENTS_ALL — U.S. federal payment sequence assignments referencing the reason.
• FV_TOP_EXCLUSION_CRITERIA_ALL — federal exclusion criteria referencing the reason.
• FND_TERRITORIES — the parent table providing valid values for TERRITORY_CODE.

Collectively these relationships confirm the table's role as a central reference entity for payment reason data across the Payments and Federal payment sub-ledgers.