Search Results pay_range_table_api




Overview
Explore in AI Chat

Overview

PAY_RANGE_TABLE_API is an Oracle E-Business Suite PL/SQL package owned by the APPS schema that provides the standard application programming interface for maintaining payroll range tables. Range tables define the numeric or alphabetic boundaries used by Oracle Payroll to determine which tax rates, deduction amounts, or other calculative values apply to a given employee, assignment, or payroll run. The package encapsulates the business logic and validation rules required to create, modify, and remove these range definitions so that the underlying payroll tables are never manipulated directly.

As a member of the public payroll API family, PAY_RANGE_TABLE_API is classified as an API and is validated against Oracle EBS 12.1.1 and 12.2.2. It is intended to be called by other Oracle applications and by customer extensions rather than through direct SQL, ensuring that all database integrity rules, legislative validation, and multi-organization security checks are enforced.

Key Procedures and Functions

The documented interface exposes three procedures, each corresponding to a distinct lifecycle operation on range table data:

  • CREATE_RANGE_TABLE — Inserts a new range table definition. The procedure applies the standard payroll validation and derives any dependent records required for the range table to become active and usable by payroll processing.
  • UPDATE_RANGE_TABLE — Modifies an existing range table, including its effective-dated values. The procedure enforces date-track consistency so that historical payroll results are not invalidated by changes to previously processed ranges.
  • DELETE_RANGE_TABLE — Removes a range table that is no longer required. Typically this operation is subject to referential integrity checks that prevent deletion of tables still referenced by payroll elements or calculations.

Each procedure follows the standard Oracle HRMS API convention of accepting a business group context and returning a success or error status, allowing the caller to handle failures gracefully within a larger transaction.

Tables Accessed

PAY_RANGE_TABLE_API accesses its base data through APPS synonyms. The documented tables it references are:

  • HR_LEGISLATION_INSTALLATIONS — Used to confirm that the target legislation is installed and available before a range table is created or amended.
  • HR_ORGANIZATION_INFORMATION — Used to associate the range table with the correct business group and organization context, supporting multi-organization access control.

Additional payroll range and range-value tables are accessed through the underlying package body, but the documented references above confirm the legislative and organizational validation performed on every invocation.

Usage Notes

PAY_RANGE_TABLE_API is invoked primarily from Oracle Payroll setup forms and from the payroll tax table upload programs. The ETRM metadata confirms that the package is referenced by PAY_NO_TAX_TABLE_UPLOAD and PAY_SE_TAX_TABLE_UPLOAD, both of which are concurrent-program driven loaders for statutory tax tables. These programs call CREATE_RANGE_TABLE, UPDATE_RANGE_TABLE, and DELETE_RANGE_TABLE to keep range definitions synchronized with legislative updates.

Customers extending payroll functionality should call this API rather than performing DML against payroll range tables directly, because the API centralizes validation and preserves date-tracked history. Calls should be committed by the caller, and error handling should examine the returned status to determine whether the requested operation succeeded.