Search Results p_comp

Overview

The APPS.PAY_CA_TAXABILITY_RULES_PKG package body provides the core building blocks used to maintain Canadian taxability rules stored in the Oracle E-Business Suite Payroll (PAY) schema. Canadian payroll taxation requires jurisdiction-specific and classification-specific determination of which earnings, deductions, and boxes are taxable under federal, provincial, and other statutory regimes. This package encapsulates the logic needed to query and modify the effective-dated taxability rule definitions that drive those determinations. It is classified in ETRM as an OTHER API, indicating it is not a fully published public interface but a supporting internal utility used by the product's own forms and processes. The package depends on HR_UTILITY for error raising and messaging conventions common throughout Oracle HRMS and Payroll modules. Its header comment (paycaetw.pkb, version 120.1) and change list show it was created in 1998 and extended in 2005 to add the tax type PPIP, confirming its role as a long-lived maintenance component for Canadian taxability configuration.

Key Procedures and Functions

• GET_OR_UPDATE — The primary entry point, this procedure operates in two modes (governed by an X_MODE parameter) so that a single routine can either retrieve an existing taxability rule record or create/update one. It works with a jurisdiction, tax category, classification identifier, and legislation code to identify the applicable rule, and returns/accepts a taxability rules date identifier together with valid-from and valid-to dates. The extensive X_BOX1 through X_BOX10 in-out parameters carry the taxable-box indicator values associated with the rule, allowing the calling form to both display and persist box-level taxability settings. Embedded application context (X_CONTEXT) and session date parameters support effective-dated and session-aware processing. The header copyright and revision comments place this logic firmly in the Canadian (CA) taxability maintenance area.
• GET_CLASSIFICATION_ID — A supporting function that resolves a payroll element classification identifier. It supplies the classification value used to qualify which taxability rules apply to a given element category, enabling the calling code to translate element classification context into the key required by the taxability rules tables.

Tables Accessed

• PAY_TAXABILITY_RULES — The central configuration table holding the taxability rule definitions. The package reads and writes here to maintain which tax categories and boxes are taxable for a given classification and jurisdiction.
• PAY_TAXABILITY_RULES_DATES — Stores the effective-dated segments of each rule. The dates identifier (X_taxability_rules_date_id) and valid-from/valid-to values handled by GET_OR_UPDATE correspond directly to rows in this table, providing the temporal versioning that payroll requires.
• PAY_ELEMENT_CLASSIFICATIONS — The element classification definitions used by GET_CLASSIFICATION_ID to resolve the classification identifier that scopes applicable taxability rules.

Usage Notes

This package is typically invoked by the Canadian taxability rules maintenance form within Oracle Payroll, where administrators define and adjust which boxes are taxable per jurisdiction and element classification. The GET_OR_UPDATE dual-mode design is characteristic of Oracle HRMS maintenance utilities: the form first calls it in query mode to populate the current rule and box values, then calls it in update mode to save changes. Because ETRM lists no packages referencing it, it is not a generally reused API and should be treated as an internal implementation component. Custom code should invoke it only when replicating the standard maintenance form's behavior, and must pass the full set of box parameters and context values exactly as the form does. Direct DML against the underlying taxability tables is not recommended; using this package preserves HR_UTILITY error handling and effective-date integrity.