Search Results deduction_amount

Overview

The view IGS_FI_F_RET_SCHD_HT is a financial retention schedule history view belonging to the IGS – Student System product family in Oracle E-Business Suite. Within the ETRM repository the object is classified as obsolete: the metadata states plainly that it is "Not implemented in this database." This designation is significant for anyone researching the object, because it means the view is not deployed in a standard 12.1.1 or 12.2.2 installation and cannot be queried directly in a typical environment. Its documentation survives only as historical reference material carried forward from earlier IGS releases.

The view exposes the history rows of retention schedule definitions. In the student financials domain, retention schedules determine how much of a fee or charge is retained by the institution versus refunded or released to a student. The _HT suffix follows the Oracle Applications convention for history/audit tables, indicating that the view presents time-stamped versions of retention schedule records rather than the live transactional rows. The presence of HIST_START_DT, HIST_END_DT, and HIST_WHO columns confirms this purpose: each row represents a date-effective snapshot of a retention schedule configuration and records who effected the change.

Underlying Base Objects

The view is defined over a single base object, IGS_FI_F_RET_SCHD_HT_ALL. The _ALL suffix indicates that the underlying table is partitioned or filtered by operating unit through the ORG_ID column, which aligns with multi-org access control conventions used throughout Oracle EBS financials and student system tables. The view text selects all columns from this table and applies an operating unit restriction derived from the USERENV('CLIENT_INFO') session parameter, extracting the first ten characters to identify the current organization context. Where no organization is resolved, the expression defaults to -99, ensuring that unqualified queries still return a consistent, if empty, result set rather than failing.

ETRM does not document any additional referenced base objects beyond IGS_FI_F_RET_SCHD_HT_ALL. There are no documented joins to calendar, fee, or academic configuration tables within the view definition itself, so all descriptive context such as fee calendar type and date alias must be resolved by joining outward to the relevant IGS setup tables.

Key Columns

• SCHEDULE_NUMBER — The identifier of the retention schedule being versioned; this is the column a user searching on "schedule_number" will be seeking.
• FEE_CAL_TYPE and FEE_CI_SEQUENCE_NUMBER — The fee calendar type and its calendar instance sequence, anchoring the schedule to an academic fee period.
• FEE_TYPE and FEE_CAT — The fee classification and category to which the retention rule applies.
• S_RELATION_TYPE — The student relationship type used to segment retention rules by cohort.
• SEQUENCE_NUMBER — Ordering key for rows within the schedule definition.
• DT_ALIAS and DAI_SEQUENCE_NUMBER — The date alias and date alias instance that drive the effective dating of the retention calculation.
• RETENTION_PERCENTAGE, RETENTION_AMOUNT, and DEDUCTION_AMOUNT — The monetary and percentage terms of retention.
• HIST_START_DT, HIST_END_DT, HIST_WHO — History validity window and the user who made the change.
• ORG_ID plus the standard WHO columns (CREATED_BY, CREATION_DATE, LAST_UPDATED_BY, LAST_UPDATE_DATE, LAST_UPDATE_LOGIN) — Multi-org and audit tracking.

Common Use Cases and Queries

The principal reporting use case is reconstructing the retention terms that applied to a given fee schedule at a point in time, typically for refund disputes, audit, or reconciliation. A query retrieving the current history row for a schedule might read:

SELECT schedule_number, fee_cal_type, fee_type, retention_percentage,
       retention_amount, hist_start_dt, hist_end_dt
FROM   igs_fi_f_ret_schd_ht
WHERE  schedule_number = :schedule_number
AND    TRUNC(SYSDATE) BETWEEN hist_start_dt AND NVL(hist_end_dt, SYSDATE);

Because the object is obsolete and not implemented in current 12.1.1 or 12.2.2 databases, this SQL will not execute in a standard installation. Consultants encountering the view should treat it as a historical artifact and inspect the contemporary IGS retention schedule tables in the target environment for equivalent functionality before attempting any migration or report rewrite.