Search Results pay_us_tax_bals_adj_api




Overview
Explore in AI Chat

Overview

PAY_US_TAX_BALS_ADJ_API is a public PL/SQL API packaged under the APPS schema that provides the United States–specific tax balance adjustment functionality within Oracle Payroll. The package is declared with AUTHID CURRENT_USER and is documented under the Enterprise Repository metadata as "Tax Balance Adjustment for United States," with a product scope of Oracle Payroll (PER). Its principal business purpose is to create adjustments against an employee assignment's tax balances within a given jurisdiction, but only where taxes already exist for that jurisdiction. The package performs the US Payroll–specific validations that must precede the creation of the underlying adjustment records, ensuring that tax balance adjustments are applied only in a valid payroll and tax context.

Key Procedures and Functions

The package exposes one documented public procedure, CREATE_TAX_BALANCE_ADJUSTMENT, whose name matches the user's search term. Its documented behavior is as follows:

  • CREATE_TAX_BALANCE_ADJUSTMENT — Performs validations specific to US Payroll and, provided those validations succeed, creates the corresponding tax balance adjustment records for the given assignment. The documented parameters govern validation-only execution (p_validate), the effective date of the adjustment (p_adjustment_date, associated with PAY_PAYROLL_ACTIONS.EFFECTIVE_DATE), the business group (p_business_group_name), the target assignment (p_assignment_number), the tax unit (p_tax_unit_id, associated with PAY_ASSIGNMENT_ACTIONS.TAX_UNIT_ID), the consolidation set (p_consolidation_set, associated with PAY_CONSOLIDATION_SETS.CONSOLIDATION_SET_ID), and the earning element type (p_earning_element_type, associated with PAY_BALANCE_TYPES).

The package declares two documented entry points in total (procedures and functions combined), with CREATE_TAX_BALANCE_ADJUSTMENT being the primary public interface. Note that parameter lists should not be inferred beyond the documented metadata.

Tables Accessed

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

Usage Notes

This API is licensed for use with Oracle Human Resources and requires that an assignment record exists in the relevant Business Group as a prerequisite. It is typically invoked from Oracle Payroll's US tax balance adjustment flows, from concurrent program logic, or from custom PL/SQL code that needs to programmatically create tax balance adjustments. Because the procedure is documented with a p_validate parameter, callers can first invoke it in validation-only mode to confirm that all US Payroll validations pass before committing adjustments to the database. If validations fail, the process errors out rather than partially applying changes. The API is referenced by zero other packages in the documented metadata, indicating it is a leaf-level public API intended for direct external invocation rather than internal package chaining. As with all public ETRM APIs, it should be called as APPS.PAY_US_TAX_BALS_ADJ_API.CREATE_TAX_BALANCE_ADJUSTMENT in both Oracle EBS 12.1.1 and 12.2.2 environments.