Search Results x_box10

Overview

PAY_CA_TAXABILITY_RULES_PKG is an Oracle EBS Payroll (PAY) package owned by the APPS schema and classified under ETRM as an OTHER API. Its name identifies it as the Canadian localization component responsible for resolving taxability rules — the configuration that determines whether a given payroll element is subject to a particular tax, and at what level. In Canadian payroll, taxability is governed by federal and provincial legislation and must be effective-dated, since rates and treatment change across tax years and legislative amendments. This package provides the programmatic interface through which Oracle Payroll and its Canadian localization layer look up the taxability treatment associated with an element classification and, where required, create or update the supporting rule rows.

The object is documented as VALID in the APPS schema and, per the dependency section of the ETRM record, references only SYS.STANDARD. The package specification and body are both present, and the "referenced by" list contains only the package itself, indicating that no other documented package depends directly on it.

Key Procedures and Functions

The ETRM metadata documents two callable units within this package:

• GET_OR_UPDATE — Serves as the primary entry point for retrieving an existing taxability rule record or creating/refreshing it when none exists. Its dual naming reflects an idempotent pattern common in Oracle localization APIs, where the caller supplies rule criteria and the routine either returns the matching configuration or persists a new one. Because the documented metadata does not expose a parameter list, callers should consult the package specification in the target instance before invoking it directly.
• GET_CLASSIFICATION_ID — Resolves and returns the element classification identifier used as the key for taxability rule lookup. Element classifications (such as earnings, deductions, and imputed earnings) drive how payroll elements are processed and taxed, so this routine is the bridge between a payroll element and its classification-based tax treatment.

Both units are documented as procedures/functions of the package; no additional public members are recorded in the ETRM extract.

Tables Accessed

The package operates against three documented base tables, accessed through APPS synonyms:

• PAY_ELEMENT_CLASSIFICATIONS — Provides the classification definitions used to derive the classification identifier returned by GET_CLASSIFICATION_ID.
• PAY_TAXABILITY_RULES — Stores the effective taxability rule definitions. This is the table read during lookup and written when GET_OR_UPDATE creates or modifies a rule.
• PAY_TAXABILITY_RULES_DATES — Holds the date-effective segments for taxability rules, enabling correct rule selection for a given payroll period or tax year.

Together these tables form the configuration backbone for Canadian element-level taxability, and the package centralizes access to them rather than requiring callers to manipulate the tables directly.

Usage Notes

This package is a localization-level API and is typically invoked through Canadian payroll configuration flows rather than by end users. It is most commonly reached from Oracle Payroll setup forms that maintain element classifications and taxability rules, and from seed or upgrade routines that establish taxability configuration during localization installation and patching. Custom code and Fast Formula extensions that need to determine whether an element is taxable — or that must create the corresponding rule — should call the documented procedures rather than issuing direct DML against PAY_TAXABILITY_RULES and PAY_TAXABILITY_RULES_DATES, since the package encapsulates the required date-effective logic.

Because the package is dependent only on SYS.STANDARD, no other application packages need to be initialized before it is called. Its behavior is consistent across Oracle EBS 12.1.1 and 12.2.2; the 12.2.x online patching model does not alter the package's interface, though it does affect when the compiled specification is refreshed.