Search Results not_applicable




Overview
Explore in AI Chat

Overview

APPS.PAY_US_TAX_UDFS_PKG is a United States payroll tax user-defined function (UDF) package within the Oracle E-Business Suite Payroll (PAY) module. Its declared purpose is to support the calculation and persistence of alternate flat-rate tax calculation methods for US state-level withholding, using assignment action and element type context. The package is defined with AUTHID CURRENT_USER, meaning its SQL executes under the privileges of the invoking schema, and it exposes a small, focused API of two public functions.

The package also declares a PL/SQL record type, etei_data_rec, and a collection type, etei_data_tab, indexed by BINARY_INTEGER, together with a package-level collection variable etei_data_val. These structures carry assignment action, element type, state code, and calculation method information — the "etei" naming aligns with the PAY_ELEMENT_TYPE_EXTRA_INFO table referenced in the metadata, indicating the package's role in managing extra element information tied to US state tax processing.

Key Procedures and Functions

  • GET_ALTRNT_FLAT_RATE_CALC_METH — a function returning VARCHAR2 that retrieves the alternate flat-rate calculation method applicable to a given assignment action and state code. It is the read side of the package's paired API, returning the stored calculation method code (typically a lookup code drawn from FND_LOOKUP_VALUES).
  • SET_ALTRNT_FLAT_RATE_CALC_METH — a function returning NUMBER that records or updates the alternate flat-rate calculation method for an assignment action, element type, and date earned, scoped to a state code. Its parameters for state code and calculation method default to the literal value 'NOT_APPLICABLE', which is the search term associated with this object and reflects how the API represents an unspecified or inapplicable context. The numeric return value conventionally signals success or failure of the write operation.

No other public procedures or functions are documented.

Tables Accessed

  • PAY_ASSIGNMENT_ACTIONS — supplies the assignment action identifier that keys payroll processing context; the record type stores assignment_action_id from this table.
  • PAY_ELEMENT_TYPES_F — provides the element type identifier that identifies the payroll element for which the alternate flat-rate method applies.
  • PAY_US_STATES — supplies the state code used to distinguish US state withholding jurisdictions.
  • FND_LOOKUP_VALUES — the source of the calculation method lookup code stored in the record type.
  • PAY_ELEMENT_TYPE_EXTRA_INFO — the likely persistence target for the extra element information associated with the alternate flat-rate method; the "etei" record and table types correspond to this table.
  • PLITBLM — a standard Payroll PL/SQL table used for bulk/array processing.

All tables are referenced through APPS synonyms, consistent with the package being owned by APPS.

Usage Notes

The package is classified as OTHER under the ETRM API classification scheme and is not referenced by any other documented package, indicating it is an internal or supporting utility rather than a broadly reused public API. It is typically invoked from US payroll tax processing logic — for example, from a user-defined formula or a payroll calculation routine — where a state requires an alternate flat-rate withholding method to be derived and stored per assignment action. Custom code may call SET_ALTRNT_FLAT_RATE_CALC_METH to establish the method and GET_ALTRNT_FLAT_RATE_CALC_METH to read it back. The default literal 'NOT_APPLICABLE' documents the sentinel value used when no state or method qualifies, and callers should expect the function signatures carried forward from the 11i header (pyustudf.pkh 115.4, 2004) remain stable across EBS 12.1.1 and 12.2.2.