Search Results update_range

Overview

PAY_RANGE_API is an Oracle E-Business Suite PL/SQL package in the APPS schema that provides the application programming interface for maintaining range records used by Oracle Payroll tax tables. Tax tables in Payroll must be defined across effective-dated bands, where each band associates a lower threshold, an upper threshold, and one or more monetary amounts that drive payroll calculations. The package encapsulates the creation, modification, and removal of these range rows so that the underlying tables are only touched through a controlled, versioned interface.

The header comment identifies the package as internal development use only, meaning it is intended to back product functionality and Payroll setup flows rather than to be called directly by external integrations. The presence of an object version number in the interface confirms that it participates in Oracle EBS date-tracked, version-controlled data maintenance via the standard API pattern.

Key Procedures and Functions

• CREATE_RANGE — Inserts a new range record for a tax table. The documentation states that P_RANGE_TABLE_ID, P_LOW_BAND, P_HIGH_BAND, and P_AMOUNT1 must be supplied for the call to succeed. The remaining amount columns (P_AMOUNT2 through P_AMOUNT8) and the effective date parameters are optional, allowing a range to be defined with a subset of amount values. The procedure returns the generated range identifier and the object version number to the caller.
• UPDATE_RANGE — Modifies an existing range record. This is the procedure associated with the update_range search term. It allows correction or adjustment of band boundaries and amount values on a range that already exists, and it follows the same date-tracked, version-checked maintenance pattern as creation. Callers must supply the identifying information for the target range together with the object version number so that concurrent updates can be detected.
• DELETE_RANGE — Removes a range record. The procedure provides the supported mechanism for withdrawing a band from a tax table, typically performed as part of effective-dated table maintenance rather than as a physical purge of historical data.

Tables Accessed

The ETRM metadata for this package lists no directly referenced tables, which is consistent with Oracle EBS API design conventions: the public package delegates all SQL operations to a private package or to another internal layer, and the documented tables are therefore not exposed at the API surface. Functionally, the package operates on the Payroll range table that stores band definitions for tax tables, identified by the RANGE_TABLE_ID foreign key passed by the caller. The range identifier returned by CREATE_RANGE corresponds to the primary key of that range table.

Usage Notes

PAY_RANGE_API is normally invoked indirectly. Payroll tax table setup forms and related concurrent processes call it when users define or amend ranges, and the metadata records that two other packages reference it, indicating that it also serves as a building block for higher-level Payroll APIs. Custom code should invoke CREATE_RANGE, UPDATE_RANGE, or DELETE_RANGE rather than issuing DML against the underlying range table, because the API enforces the required parameters, manages effective dates, and maintains the object version number needed for consistent date-tracked updates. When updating an existing band, callers should pass the current object version number returned from a prior query or API call; a mismatch signals that the record was changed concurrently and the update should be re-attempted.