Search Results x_box2

Overview

APPS.PAY_CA_TAX_RULES_GARN_PKG is a Canadian (CA) payroll taxability rules package delivered as part of the Oracle E-Business Suite payroll engine. Its responsibility is to resolve and, where required, maintain the taxability rule records for a given jurisdiction, tax category, and element classification, and to return the associated tax box values that drive payroll tax reporting. In the Oracle EBS 12.1.1 and 12.2.2 data model, taxability rules link a jurisdiction code, tax type, and tax category to a specific element classification and to a dated rule set, so the package effectively provides the lookup layer that answers the question "for this classification in this jurisdiction on this session date, what taxability rule applies, and what box indicators should be reported?" The package is classified as OTHER in the ETRM inventory and exposes two documented entry points, GET_OR_UPDATE and GET_CLASSIFICATION_ID.

Key Procedures and Functions

The documented API surface consists of two callable units:

• GET_OR_UPDATE — The principal routine. It resolves the effective taxability rules date for a supplied legislation code and session date, then either retrieves an existing PAY_TAXABILITY_RULES row or creates/updates one for the supplied jurisdiction, tax category, element classification, and legislation. Internally it operates on the X_BOX1 and X_BOX2 out parameters, which carry the tax box indicators back to the caller, and it returns the resolved taxability_rules_date_id together with the valid date range. The routine uses a private nested helper, get_date_info, to select the active PAY_TAXABILITY_RULES_DATES row whose VALID_DATE_FROM and VALID_DATE_TO bracket the session date, and a private check_row_exist function to determine whether a matching rule row already exists before deciding whether to insert or update. Note that the source header identifies this file as an obsolete or replaced object (pycadiat.pkb, 120.1), so callers should treat the routine as a legacy lookup rather than a maintained extension point.
• GET_CLASSIFICATION_ID — The companion lookup that resolves the classification identifier used to key the taxability rule. It supplies the classification_id consumed by GET_OR_UPDATE, allowing a caller to obtain or confirm the element classification against which Canadian taxability rules are evaluated.

No other public procedures or functions are documented; the remaining logic (get_date_info, check_row_exist) is private to the package body and must not be referenced directly. The user search term "x_box1" corresponds to the X_BOX1 parameter of GET_OR_UPDATE, the first of the two tax box output values.

Tables Accessed

The package operates against three core payroll taxability tables, all referenced through APPS synonyms:

• PAY_TAXABILITY_RULES_DATES — Read to locate the dated rule set that is effective on the session date for the supplied legislation code, returning TAXABILITY_RULES_DATE_ID, VALID_DATE_FROM, and VALID_DATE_TO.
• PAY_TAXABILITY_RULES — Read to verify whether a rule row already exists for the jurisdiction, tax type, tax category, classification, and rule date; written when GET_OR_UPDATE inserts or updates the rule and its box indicators.
• PAY_ELEMENT_CLASSIFICATIONS — Read to resolve or validate the element classification identifier that ties the rule to the payroll element being processed.

Usage Notes

Because this package is invoked by the Canadian payroll tax calculation path rather than by end users directly, it is normally called indirectly from the payroll run and from tax reporting flows that need jurisdiction-specific box values. Typical invocation points include payroll tax calculation routines, pre-payment and year-end reporting processes, and any custom code that must reproduce the taxability rule resolution performed by the seeded payroll engine. The ETRM metadata indicates the package is referenced by zero other packages, which signals that there is no documented downstream dependency inside the EBS codebase and that direct calls are almost certainly local to the Canadian payroll tax modules. Implementers extending Canadian tax behavior should prefer the supported taxability rule setup and element classification configuration over direct invocation, and should avoid placing dependencies on GET_OR_UPDATE, since the underlying source is marked as superseded. Callers that do invoke it must supply a valid session date and legislation code, and must handle the possibility that no effective date row or no matching rule exists.