Search Results current_and_ytd_balances

Overview

APPS.PAY_CN_PAYSLIP is a Oracle E-Business Suite payroll package body that supports payslip and balance reporting for Chinese payroll legislation (the CN designation denotes the China localization). Its principal business purpose is to resolve period-to-date (PTD) and year-to-date (YTD) balance values against a payroll assignment action, and to expose those values, along with run result values and currency conversion information, to the payslip presentation layer. The package encapsulates the balance-dimension resolution logic required to translate a human-readable balance name into a defined balance identifier and then retrieve its value through the standard balance engine, isolating callers from the underlying dimensional model.

The package is classified as OTHER in the ETRM 12.2.2 metadata and is present in both the 12.1.1 and 12.2.2 releases. It exposes five documented procedures and functions and is referenced by two other packages, indicating it is consumed programmatically rather than executed directly by end users.

Key Procedures and Functions

• CURRENT_AND_YTD_BALANCES — Returns the PTD and YTD values of a named balance for a given assignment action. The procedure accepts a prepaid tag, an assignment action identifier, and a balance name, and returns the current and year-to-date amounts as output parameters. This is the procedure most directly associated with the user search term "current_and_ytd_balances."
• BALANCE_TOTALS — Aggregates balance values, providing consolidated totals used in payslip and reporting output. It complements CURRENT_AND_YTD_BALANCES by returning grouped rather than single-dimension results.
• GET_RUN_RESULT_VALUE — Retrieves the value of a specific run result for an assignment action, allowing payslip rendering to display individual payroll element entries by their run result value.
• GET_EXCHANGE_RATE — Returns a currency exchange rate, enabling amounts to be presented in a business or reporting currency rather than solely in the payroll currency.
• BUSINESS_CURRENCY_CODE — Returns the business currency code applicable to the payslip context, supporting consistent currency labelling on output documents.

Tables Accessed

The package reads across the standard Oracle Payroll balance and run result model. Balance resolution uses PAY_BALANCE_TYPES, PAY_BALANCE_DIMENSIONS, and PAY_DEFINED_BALANCES to map a balance name and dimension to a defined balance identifier, with values then obtained through PAY_BALANCE_PKG against PAY_RUN_RESULT_VALUES and PAY_RUN_RESULTS. Assignment and payroll context is drawn from PAY_ASSIGNMENT_ACTIONS and PAY_PAYROLL_ACTIONS. Element and input value metadata come from PAY_ELEMENT_TYPES_F and PAY_INPUT_VALUES_F, while user-defined columns are sourced from PAY_USER_COLUMNS and PAY_USER_COLUMN_INSTANCES_F. Organisation context is obtained from HR_ORGANIZATION_INFORMATION. Currency and conversion data are read from FND_CURRENCIES, GL_DAILY_RATES, and GL_DAILY_CONVERSION_TYPES. All access is through APPS synonyms, and the package is understood to read rather than maintain this data.

Usage Notes

PAY_CN_PAYSLIP is not intended for direct invocation by end users. It is invoked from the China payslip presentation layer — typically a concurrent program, an Oracle Reports or BI Publisher payslip layout, or an OA Framework page — and from custom or localization code that requires PTD and YTD balance values in a formatted form. Because it is referenced by two other packages, callers should treat it as a shared utility and avoid modifying its behaviour. The balance name passed to CURRENT_AND_YTD_BALANCES must exist in PAY_BALANCE_TYPES with a matching dimension, otherwise no value is returned. Site-specific extensions should wrap the documented procedures rather than alter the package body, ensuring upgrade safety across 12.1.1 and 12.2.2.