Results for “pay_grossup_bal_exclusions”

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

Overview

PAY_GROSSUP_BAL_EXCLUSIONS is a Payroll (PAY) module table owned by the HR schema in Oracle E-Business Suite 12.1.1 and 12.2.2. Its documented purpose is to store the balances that must be excluded from gross-up processing performed by the net-to-gross payroll calculation. When Payroll runs a net-to-gross (gross-up) computation, the engine iterates through the balances contributing to a payment and grosses them up to cover the associated tax liabilities. Certain balances, however, are not subject to this gross-up logic, and this table records those exceptions, providing the payroll engine with an explicit inclusion/exclusion control list keyed by balance type and effective dates.

From the ETRM relationship metadata, this object carries a heuristic Data Vault classification of satellite-leaning. This classification is a modeling suggestion: the table primarily stores descriptive, attribute-style context around a parent key (balance type) rather than acting as a canonical hub of unique business entities or a link resolving many-to-many relationships. As a satellite, its effective-dated records (START_DATE / END_DATE) describe the changing state of the exclusion definition over time.

Key Information Stored

The table contains twelve documented columns. The most significant include:

• GROSSUP_BALANCES_ID — The surrogate primary key, enforced by PAY_GROSSUP_BAL_EXCLUSIONS_PK. It uniquely identifies each exclusion rule row.
• BALANCE_TYPE_ID — Foreign key to PAY_BALANCE_TYPES, identifying which balance is being excluded from gross-up. This is the primary business attribute of the rule.
• START_DATE and END_DATE — The effective-dating range during which the exclusion applies, allowing historical and future-dated rules.
• SOURCE_TYPE and SOURCE_ID — Define the owning context or source of the exclusion rule, distinguishing the record's origin within the payroll configuration model.
• OBJECT_VERSION_NUMBER — Standard optimistic locking column used by the Oracle framework to detect concurrent updates.
• Audit columns — CREATED_BY, CREATION_DATE, LAST_UPDATE_DATE, LAST_UPDATED_BY, and LAST_UPDATE_LOGIN — capture who created and last modified each record.

A secondary unique index, PAY_GROSSUP_BAL_EXCLUSIONS_UK1, spans BALANCE_TYPE_ID, START_DATE, END_DATE, SOURCE_TYPE, and SOURCE_ID. This acts as the business-key candidate, guaranteeing that no duplicate exclusion rule exists for the same balance within the same effective window and source context. The distinction is important: GROSSUP_BALANCES_ID is a system-generated surrogate, while UK1 represents the meaningful uniqueness constraint understood by functional users.

Common Use Cases and Queries

Typical use cases center on auditing and troubleshooting net-to-gross results. Payroll administrators and technical consultants query this table to determine why a particular balance was or was not grossed up. A representative query joins the exclusion rules to the balance type definition:

• Retrieve all active exclusions: SELECT exclusions.balance_type_id, balance.user_balance_name, exclusions.start_date, exclusions.end_date FROM pay_grossup_bal_exclusions exclusions, pay_balance_types balance WHERE exclusions.balance_type_id = balance.balance_type_id AND sysdate BETWEEN exclusions.start_date AND NVL(exclusions.end_date, sysdate);
• Diagnose a specific balance: filter on BALANCE_TYPE_ID to confirm whether the balance is intentionally excluded for the relevant SOURCE_TYPE and SOURCE_ID.
• Historical trend reporting: order by START_DATE to review how the set of excluded balances has evolved.

These queries support payroll reconciliation, gross-up variance analysis, and configuration review during implementation or upgrade. Because exclusion rules are effective-dated, any point-in-time analysis must constrain against START_DATE and END_DATE rather than relying on current rows alone.

Related Objects

The most significant related objects are those tied through the documented foreign key and by payroll domain proximity:

• PAY_BALANCE_TYPES — The primary foreign-key reference, joined on BALANCE_TYPE_ID, supplying the human-readable balance name and definition.
• PAY_GROSSUP_BALANCES — The gross-up configuration counterpart; the GROSSUP_BALANCES_ID prefix suggests a shared naming lineage with the main gross-up balance rules.
• PAY_BALANCES and PAY_BALANCE_DIMENSIONS — Provide the balance and dimensional context used when the net-to-gross process evaluates which values to exclude.
• PAY_RUN_BALANCES — Stores calculated results; exclusions defined here directly influence whether run balances are grossed up.
• PAY_PAYROLL_ACTIONS and the net-to-gross calculation routines — Consume exclusion definitions at runtime.

Together these objects form the configuration surface that governs gross-up behavior, with PAY_GROSSUP_BAL_EXCLUSIONS acting as the authoritative exclusion list consulted by the payroll net-to-gross engine.