Professional Documents
Culture Documents
White Paper:
Balance Views
June 1998
This document was prepared to assist the customer in the use of the Oracle HRMS. Its contents may not be
used for any other purpose without written permission. The material contained herein is supplied without
representation or warranty of any kind including any implied warranties or merchantability. Oracle
Corporation assumes no responsibility and shall have no liability of any kind from the supply or use of this
document and the material it contains.
This publication could include technical inaccuracies or typographical errors. Changes are periodically
made to the information herein; these changes will be incorporated in new editions of the publication.
These are licensed materials for internal and customer use only, all rights reserved, including the right to
photocopy, reproduce, translate, or make other reproductions of this document or any part thereof.
All other products or company names are used for identification purposes only, and may be trademarks of
their respective owners.
Balance View Technical Reference
June 15, 1998
Introduction:
The balance views allow for simple person and assignment level balance reporting. They are logically
grouped by jurisdiction level, employee or employer, and by classifications. This functionality supplements
the current balance user exit balance reporting capability.
Federal balances views(For FIT, Social Security, Medicare, FUTA, and EIC)
--Employee:
-- PAY_US_FED_TAXES_V
-- PAY_US_FED_EE_WAGES_V
--Employer:
--PAY_US_FED_LIABILITIES_V
--PAY_US_FED_ER_WAGES_V
Earnings and Deductions (All primary and hours balances related to US Earnings and Deductions):
--Employee(Only):
--PAY_US_EARNINGS_AMOUNTS_V
--PAY_US_EARNINGS_HOURS_V
--PAY_US_DEDUCTION_AMOUNTS_V
NOTE: These are the same earnings and deductions displayed on the on line Statement of Earnings.
The numeric balance values are found in the following columns:
Column Name Description
CURRENT_VAL Run level if the assignment action is the only one related to the
corresponding prepayment. If multiple runs exist for the associated
prepayment assignment action then it is the sum of the associated
runs. This is equivalent to the ‘Current’ Column on Checks, deposit
advice, and the payroll register.
RUN_VAL Value of the balance for the run
PTD_VAL Period to date value of the balance
PYDATE_VAL Check date(or Payment date) value of the balance
MONTH_VAL Month to date Value of the balance
QTD_VAL Quarter to date Value of the balance
YTD_VAL Year to date Value of the balance
NOTE: For performance reasons only select the time dimensions required for your report or form. Querying
columns that you do not intend to display will cause the views to do unnecessary work.
When joining to the views use the following columns:
Column Name Description Comments
Assignment_action_id Assignment action id of all Improve performance by joining
assignment actions of type Run, on this and Tax unit id. You must
Quick pay, Balance adjustment, join on both to take best
balance initialization, and advantage of the underlying
Reversal indexes.
Tax_Unit_Id The GRE/Legal Entity id of the Again, it is recommended that
assignment when the assignment you join on this column in
action took place. combination with
Assignment_action_id.
Action_Type Type of assignment action. R = Run, V = Reversal,
I = Initialization, B =Balance
adjustment, Q = Quick Pay
Effective_Date Effective date of the Assignment This is the effective date of the
Action balance activity
User_Reporting_Name Reporting name of balance Reporting name of the balance
Tax_Type_code Abbreviation of tax type FIT, FUTA,SS, Medicare, EIC,
SIT, SUI, SDI, WC, CITY,
COUNTY, SCHOOL.
Only applicable on tax related
views.
Balance_Category_Code Abbreviation of balance Category Taxable, Subject, withheld,
liability.
Only applicable on tax related
views.
State_Tax_Name, This is tax type concatenated with Only applicable on state and local
Local_Tax_Name jurisdiction name. views.
Jurisdiction_code Geocode of the jurisdiction of the Only applies to tax related views.
balance if state or local level If you join on jurisdiction code it
is recommended that you disable
the index by appending a NULL
to the view jurisdiction_code
column.(For Example:
SELECT <items>
FROM <tax view of interest>
WHERE jurisdicion_code||’’ =
‘36-124-9982’
AND …..
Assignment_id The ID of the associated The ID of the associated
assignment. assignment.
Example:
To get all local taxes withheld for an employee with assignment_id = 514, for all payroll actions since 01-
JAN-1998 run the following SQL:
SELECT local_tax_name,
tax_type_code,
run_val, ytd_val,
to_char(effective_date, ’DD-MON-YYYY’) PAYMENT_DATE,
action_type
FROM pay_us_local_taxes_v
WHERE assignment_id = 514
AND effective_date > to_date(’01-JAN-1998’, dd-mon-yyyy’)
’
SELECT local_tax_name,
tax_type_code,
run_val, ytd_val, to_char(effective_date, ’DD-MON-YYYY’) PAYMENT_DATE,
action_type
From pay_us_local_taxes_v
WHERE assignment_action_id = 39134
AND tax_unit_id = 101
All session variables are set for the duration of the session only, and can be reset at anytime during the
session.
1. To obtain W2 Wages = W2 Subject = Reduced Subject instead of standard Subject wages for balance
category ‘Subject’ you must make the following procedure call before selecting from the views:
pay_us_balance_view_pkg.set_session_var(‘REPORT_TYPE’, ‘W2’);
This function converts the subject wages returned by the views to W2 Subject wages. Where:
pay_us_balance_view_pkg.set_session_var(‘REPORT_TYPE’, ‘DEFAULT’);
2. By default the PYDATE and MONTH columns return Null(Not Zero). To activate these columns use
the following call:
pay_us_balance_view_pkg.set_calc_all_timetypes_flag(1)
pay_us_balance_view_pkg.set_calc_all_timetypes_flag(0)
3. By default the views return Assignment level balances. To retrieve Person-level balances, make the
following call prior to selecting from the View:
pay_us_balance_view_pkg.set_view_mode(‘PER’);
To view assignment balances again within the same session call the following:
pay_us_balance_view_pkg.set_view_mode(‘ASG’);
Appendix: Descriptions of all Balance Views:
PAY_US_FED_EE_WAGES_V