Search Results get_run_result_value

Overview

PAY_CN_PAYSLIP is an Oracle E-Business Suite payroll package owned by the APPS schema and classified as an OTHER API within the ETRM repository. Its purpose is to support the generation of Chinese statutory payslip output and the payroll balance reporting that underpins it. The package assembles the balance figures that appear on a payslip — period-to-date (PTD) and year-to-date (YTD) earnings, taxable and non-taxable earnings, voluntary deductions, statutory deductions — and resolves the currency and exchange-rate context in which those amounts must be presented. It is tightly coupled to the Oracle Payroll core tables and to the balance and run-result model, which means it operates on payroll run data rather than on transactional HR data.

Key Procedures and Functions

The documented API exposes five callable units:

• CURRENT_AND_YTD_BALANCES — Returns the PTD and YTD values of a named balance for a given assignment action, so that a payslip line can show both the current period amount and the cumulative amount.
• BALANCE_TOTALS — Returns PTD and YTD aggregates for the four payslip categories: taxable earnings, non-taxable earnings, voluntary deductions and statutory deductions. This is the procedure that produces the summary blocks typically printed on a Chinese payslip.
• GET_RUN_RESULT_VALUE — Retrieves the value of a specific run result for a payroll action, providing the low-level figure that feeds balance calculations and payslip detail lines.
• GET_EXCHANGE_RATE — Resolves the conversion rate applicable between two currencies, using the daily rate and conversion type definitions, so that multi-currency payroll amounts can be presented consistently.
• BUSINESS_CURRENCY_CODE — Returns the business currency code applicable to the payroll or organization context. This function is the object that answers the searched term "business_currency_code", and it is the anchor for currency determination across the payslip output.

The package also accepts a prepaid tag and assignment action identifier on its balance procedures, reflecting the payroll action orientation of the API. No parameter lists are invented here beyond what the ETRM metadata documents.

Tables Accessed

The package reads from a focused set of payroll and general ledger tables through APPS synonyms. PAY_ASSIGNMENT_ACTIONS, PAY_PAYROLL_ACTIONS and PAY_RUN_RESULTS provide the payroll run context and the assignment-level action being reported. PAY_RUN_RESULT_VALUES supplies the individual run result values used by GET_RUN_RESULT_VALUE. PAY_DEFINED_BALANCES, PAY_BALANCE_TYPES and PAY_BALANCE_DIMENSIONS form the balance definition model used by CURRENT_AND_YTD_BALANCES and BALANCE_TOTALS. PAY_ELEMENT_TYPES_F and PAY_INPUT_VALUES_F describe the elements whose balances are being reported. PAY_USER_COLUMNS and PAY_USER_COLUMN_INSTANCES_F supply user-defined balance dimensions. For currency resolution, FND_CURRENCIES, GL_DAILY_CONVERSION_TYPES and GL_DAILY_RATES support GET_EXCHANGE_RATE and BUSINESS_CURRENCY_CODE. HR_ORGANIZATION_INFORMATION is used to determine organization-level attributes, including the business group context that drives currency selection.

Usage Notes

PAY_CN_PAYSLIP is invoked from Chinese localization payslip output — either a concurrent program or an Oracle Reports/BI Publisher layout that renders the Chinese statutory payslip — and from custom payroll extensions that need the same balance and currency logic. Because the API is classified as OTHER, it is not a supported public interface for general use; customizations should call it only where the Chinese payslip format is required. Two other packages reference it, indicating it is shared within the localization layer. The prepaid tag parameter suggests the API is also called in prepayment processing scenarios. Customers upgrading from 12.1.1 to 12.2.2 should note the header timestamp (2008) and verify behavior against their payroll patch level, since currency and balance handling may be affected by later payroll rollups.