Results for “format_value”

50+ results




Overview
Explore in AI Chat

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

Overview

IBY_PAYMENT_REASONS_VL is a language-enabled (VL) view owned by the APPS schema within the Oracle Payments (IBY) product family. It presents payment reason codes — the standardized, user-facing justifications that accompany a payment instruction, void, or cancellation in Oracle E-Business Suite — alongside their translated meaning and description text. Because the view is defined over a translation (TL) table joined to the base (B) table and filters rows using USERENV('LANG'), it automatically returns the reason-code text in the language of the current session, honoring the NLS_LANG setting. The view is documented as VALID in both EBS 12.1.1 and 12.2.2, though the underlying table definitions differ slightly between releases (12.2.2 introduced FORMAT_VALUE, TERRITORY_CODE, and OBJECT_VERSION_NUMBER). As a reporting and integration object, it is the preferred read-only entry point for developers and analysts who need payment reason codes with human-readable labels, rather than querying the B and TL tables directly.

Underlying Base Objects

The view is defined over two documented base objects, exposed to APPS as synonyms:

The join condition is B.PAYMENT_REASON_CODE = T.PAYMENT_REASON_CODE AND T.LANGUAGE = USERENV('LANG'). This inner join means a reason code appears only if a translation row exists for the session language; setup scripts typically seed translations for all installed languages. The view exposes the base table's ROWID as the first column (documented in 12.1.1 as ROWID; the 12.2.2 column list labels it ROW_ID), enabling tools to identify the underlying base row.

Key Columns

  • PAYMENT_REASON_CODE — the primary business key; the unique, language-independent identifier of the reason.
  • MEANING — the translated display name of the reason code, the column most commonly presented to users.
  • DESCRIPTION — the translated long description providing additional context.
  • FORMAT_VALUE — a formatting or display attribute associated with the reason (introduced in 12.2.x).
  • TERRITORY_CODE — the territory/country to which the reason applies, where reason codes are region-specific.
  • INACTIVE_DATE — the date after which the reason is no longer selectable; NULL indicates an active reason.
  • SEEDED_FLAG — indicates whether the row is Oracle-seeded (typically 'Y') or user-defined ('N'), useful when filtering for customer-maintained values.
  • WHO/audit columns and OBJECT_VERSION_NUMBER — standard EBS audit trail and concurrency-control attributes inherited from the base table.

Common Use Cases and Queries

Typical uses include: populating LOVs or reporting parameters with active payment reason codes; joining payment or payment-instruction records to obtain the reason text for analysis; and validating integration payloads that carry reason codes. Because the view already resolves language and includes audit columns, it removes the need for developers to join B and TL themselves. A representative query listing all active, seeded reasons in the session language is shown below.

SELECT payment_reason_code, meaning, description
FROM   apps.iby_payment_reasons_vl
WHERE  inactive_date IS NULL
AND    seeded_flag = 'Y'
ORDER  BY meaning;

To retrieve only user-defined reasons, change the predicate to seeded_flag = 'N'. When filtering by territory, add WHERE territory_code = :p_territory. Because the view resolves translations via USERENV('LANG'), sessions must have a valid NLS language context (established by the EBS sign-on or by setting NLS_LANG in a standalone client) for rows to be returned.