Search Results pay_ca_balance_pkg




Overview
Explore in AI Chat

Overview

APPS.PAY_CA_BALANCE_PKG is a Canadian payroll balance package body within the Oracle E-Business Suite Payroll (PAY) module. Its purpose is to generate and retrieve payroll balance values specific to Canadian legislative and reporting requirements, operating as a regional specialization layered over the generic payroll balance framework implemented by PAY_BALANCE_PKG. The package integrates the Oracle Payroll action processing model with Canadian balance definitions, allowing the Payroll engine to determine whether balances are required for a given action or run type, and to return current balance values during payroll processing.

The object is documented as VALID in the APPS schema. It is classified as an OTHER API type and is referenced by twenty other database objects, indicating it is a foundational internal routine that the Canadian payroll processing stack calls rather than a standalone entry point. No database object references it in turn, confirming its role as a lower-level implementation utility within the Canadian payroll balance hierarchy.

Key Procedures and Functions

The ETRM metadata documents six procedures and functions in this package. Their purposes are as follows:

  • CALL_CA_BALANCE_GET_VALUE — Wrapper routine that delegates balance value retrieval to the underlying balance retrieval logic, providing a Canadian-specific entry point for obtaining a balance value during payroll calculation.
  • GET_CURRENT_BALANCE — Returns the current (as-of-now) value of a specified Canadian payroll balance, used by the payroll engine and dependent packages when a live balance figure is required.
  • PAYMENTS_BALANCE_REQUIRED — Determines whether a payments-type balance must be calculated or maintained for the current processing context, gating balance accumulation and retrieval.
  • TURN_OFF_DIMENSION — Disables or suppresses a specific balance dimension so that it is not accumulated for the current context.
  • TURN_OFF_REPORT_DIMENSION — Disables a reporting dimension, preventing it from being materialized in Canadian balance reporting output.

Parameter lists are not exposed in the metadata and are therefore not reproduced here. Each routine operates on balance context derived from the action and interlock tables.

Tables Accessed

The package reads and writes the following tables through APPS synonyms:

  • PAY_PAYROLL_ACTIONS — the driving payroll action record for which balance context is established.
  • PAY_ASSIGNMENT_ACTIONS — assignment-level actions used to scope balance calculation.
  • PAY_ACTION_INTERLOCKS — interlock state that governs thread-safe processing of actions.
  • PAY_ACTION_CONTEXTS — context values (organization, assignment, run type) needed for balance resolution.
  • FF_CONTEXTS — FastFormula contexts providing legislative and business group parameters.
  • PAY_RUN_TYPES_F — run type definition, used to decide whether a balance applies to the current run.
  • PAY_CA_PMED_ACCOUNTS — Canadian PMED (Permanent/Medical?) account data supporting province-specific balance rules.

Those accesses represent the standard pattern for balance packages: resolve context, confirm applicability, then read or accumulate values.

Usage Notes

PAY_CA_BALANCE_PKG is not intended for direct invocation by end users or by custom concurrent programs. It is called internally by the Canadian payroll balance stack, including PAY_CA_BALANCE_VIEW_PKG and PAY_CA_GROUP_LEVEL_BAL_PKG, and by the base PAY_BALANCE_PKG and PAY_US_BALANCE_VIEW_PKG in the shared balance architecture. It obtains its session context from the payroll action and interlock tables, so it must be invoked within a properly initialized payroll run. Custom code should call these routines only after establishing action context, and should treat this package as an internal implementation detail subject to change across releases; the supported extension surface is the balance definition and FastFormula layer rather than the package itself.