Search Results pay_balance_adjustment_api




Overview
Explore in AI Chat

Overview

PAY_BALANCE_ADJUSTMENT_API is an Oracle EBS Payroll (PAY) application programming interface owned by the APPS schema and classified as a public API. Its business purpose is to create and remove balance adjustments against a payroll assignment, allowing corrections to be applied to an employee's stored payroll balances without running a full payroll process. Balance adjustments are commonly required when a prior payroll run produced an incorrect result, when a retroactive change must be reflected in a specific balance, or when data must be corrected for reporting, costing, or statutory purposes. The package is validated as VALID in both Oracle EBS 12.1.1 and 12.2.2, and it is referenced by other application modules including BEN_COBRA_REQUIREMENTS, PAY_IE_PAYE_API, and PQP_INI_BAL, indicating its role as a shared, foundational payroll data-manipulation utility rather than an end-user-only construct.

Key Procedures and Functions

  • CREATE_ADJUSTMENT — Creates a balance adjustment for a given assignment and balance. It resolves the target balance, derives the necessary payroll and time-period context, and writes the adjustment through the appropriate payroll run results and element entry structures so that the adjustment is recognized by the payroll engine and reflected in subsequent balance calculations.
  • DELETE_ADJUSTMENT — Removes a previously created balance adjustment. This procedure identifies the adjustment records associated with the assignment and period, and deletes or reverses the corresponding row-level data so the balance is returned to its pre-adjustment state.

The documented metadata lists two callable subprograms. Parameter lists must be taken from the actual package specification in the target environment, as the ETRM excerpt does not expose signature details.

Tables Accessed

Through APPS synonyms, the package interacts with the core payroll schema:

  • PAY_RUN_RESULTS — the principal store of calculated payroll results and balance-affecting values; adjustments are written here.
  • PAY_ELEMENT_ENTRIES_F — holds element entries that feed the payroll calculation and provide the mechanism by which an adjustment reaches the run result.
  • PAY_ASSIGNMENT_ACTIONS — records assignment-level actions, providing context for when an adjustment applies.
  • PAY_PAYROLL_ACTIONS and PAY_PAYROLL_ACTIONS_S — supply and track the payroll action within which the adjustment is processed.
  • PER_TIME_PERIODS — defines the time period associated with the adjustment.
  • DUAL — used for simple value retrieval and control flow.

Usage Notes

PAY_BALANCE_ADJUSTMENT_API is normally invoked programmatically rather than from a standard Payroll form. Typical callers are custom PL/SQL routines, corrective concurrent programs, and other payroll product APIs — as evidenced by its use from BEN_COBRA_REQUIREMENTS, PAY_IE_PAYE_API, and PQP_INI_BAL. A developer calling it directly should initialize the Oracle Applications session (FND_GLOBAL.APPS_INITIALIZE or equivalent) and must respect the package's validation rules, since balance adjustments affect payroll results and downstream reporting, costing, and statutory outputs. Because the metadata documents only the subprogram names, implementers should review the package specification in their specific 12.1.1 or 12.2.2 instance to confirm exact parameters, error handling, and commit behavior before deployment.