Search Results get_balance_type

Overview

APPS.PAY_US_TAXBAL_VIEW_PKG is a PL/SQL package body in the Oracle E-Business Suite (EBS) 12.1.1 and 12.2.2 environments that supports United States payroll tax balance reporting. Its principal business function is to compute, aggregate, and expose tax-related balance and gross earnings figures for US payroll assignments, for use in reporting, viewing, and downstream payroll processes. The package functions as a view-layer abstraction, returning balances that are otherwise assembled from the underlying payroll balance and run-result tables. It is classified as OTHER within the ETRM API classification, and its documented status is VALID in the APPS schema. The package is heavily integrated: it references 15 documented base tables through APPS synonyms and is itself referenced by 46 other database objects, indicating it is a widely reused utility within the payroll tax reporting layer.

Key Procedures and Functions

The package body exposes twenty documented programs that fall into several functional groups.

• Balance retrieval: US_TAX_BALANCE and its view-model counterpart US_TAX_BALANCE_VM return tax balance values for a given context. US_NAMED_BALANCE and US_NAMED_BALANCE_VM return a specifically named balance, allowing callers to resolve a balance value by identifier.
• Applicability check: PAYMENTS_BALANCE_REQUIRED determines whether a payments-related balance is required for the supplied parameters, serving as a decision gate before balance computation.
• Gross earnings (GRE) taxability aggregates: A family of functions returns gross earnings that are subject to tax or identified as multiple, by jurisdiction and period type. These include US_GP_MULTIPLE_GRE_YTD, US_GP_MULTIPLE_GRE_QTD, US_GP_MULTIPLE_GRE_MTD, and US_GP_MULTIPLE_GRE_CTD; US_GP_SUBJECT_TO_TAX_GRE_YTD, US_GP_SUBJECT_TO_TAX_GRE_QTD, US_GP_SUBJECT_TO_TAX_GRE_MTD, and US_GP_SUBJECT_TO_TAX_GRE_CTD; and US_GP_GRE_JD_YTD, US_GP_GRE_JD_QTD, US_GP_GRE_JD_MTD, and US_GP_GRE_JD_CTD.
• Specialized variant: US_GP_MULTIPLE_GRE_QTD_SS_W11 supports a specific quarter-to-date multiple gross earnings scenario.

The period suffixes correspond to year-to-date (YTD), quarter-to-date (QTD), month-to-date (MTD), and current-to-date (CTD) accumulation windows, while GRE_JD denotes a jurisdiction-related gross earnings computation.

Tables Accessed

The package reads from and operates over the following documented tables through APPS synonyms: FF_USER_ENTITIES, PAY_ACTION_INTERLOCKS, PAY_ASSIGNMENT_ACTIONS, PAY_ASSIGNMENT_LATEST_BALANCES, PAY_BALANCE_DIMENSIONS, PAY_BALANCE_FEEDS_F, PAY_BALANCE_TYPES, PAY_DEFINED_BALANCES, PAY_ELEMENT_TYPES_F, PAY_PAYROLL_ACTIONS, PAY_PRE_PAYMENTS, PAY_RUN_RESULTS, PAY_RUN_RESULT_VALUES, PAY_RUN_TYPES_F, and PAY_TAXABILITY_RULES. Payroll run results and run result values supply the raw earnings and tax figures; assignment latest balances supply pre-aggregated balance values; balance types, defined balances, dimensions, and feeds define how balances are structured and accumulated; taxability rules determine which earnings are subject to tax; and payroll actions, pay pre-payments, assignment actions, and run types provide the process context needed to select the correct pay period and run.

Usage Notes

PAY_US_TAXBAL_VIEW_PKG is typically invoked from US payroll reporting forms, concurrent programs, and custom PL/SQL that require US tax balance or gross earnings information without directly querying the underlying payroll tables. Its view-model procedures (the _VM suffix) are intended for user-interface rendering, while the non-VM procedures serve programmatic and reporting callers. Because the package is referenced by 46 other database objects and references no database objects beyond those listed, it should be treated as a stable shared dependency: modifications to its signatures or return semantics would affect a broad set of upstream payroll tax reports and processes. Prerequisite data must be present in the payroll run results, balances, and taxability rules for the requested period before the balance functions return meaningful values.