Search Results cal_hy_start

Overview

APPS.PAY_IN_EXC is an Oracle E-Business Suite payroll utility package that resides in the APPS schema and is classified as an "OTHER" API. Its role is to calculate the start dates that govern year-to-date and related balance accumulation windows during payroll processing. The package derives the effective starting point from which earnings, deductions, and other balance dimensions are accumulated, and it returns both the computed date and a corresponding start-date code that identifies which rule produced the result. The header comment, referencing pyinexc.pkh 120.1 dated 2008, confirms its long-standing function within the payroll engine across the 12.1.1 and 12.2.2 releases.

Key Procedures and Functions

• DATE_EC — Overloaded procedure that returns expiry information for a given dimension. Two signatures exist: one returns a NUMBER and the other returns a DATE, allowing callers to request expiry data in the format appropriate to the dimension being evaluated. It accepts owner and user payroll/assignment action identifiers and effective dates.
• CAL_HY_START — Calculates the start date for a half-year-to-date (HYTD) accumulation window based on the supplied effective date. Returns the computed start date and an optional start-date code.
• PROV_YT D_START — Derives the provisional year-to-date start date, used when a definitive YTD boundary is not yet available, such as during partial or run-in-progress payroll actions.
• HYTD_START — The procedure most commonly associated with the search term "hytd_start." It computes the half-year-to-date start date for balances, taking an effective date plus optional payroll, business group, action type, and assignment action parameters, and returning the start date and start-date code.
• GET_TD_START — Returns a to-date start date, providing a general entry point for to-date window calculation across supported dimensions.
• START_CODE_PMTH — Calculates a start date based on the previous month boundary, requiring an effective date, payroll, business group, and assignment action.
• START_CODE_P10MTH — Derives a start date tied to a ten-month or extended-period boundary rule, again using effective date, payroll, business group, and assignment action inputs.

Tables Accessed

• PER_ALL_ASSIGNMENTS_F — Provides assignment-level context such as hire date, payroll linkage, and effective dating required to anchor the calculation window.
• PAY_PAYROLL_ACTIONS and PAY_ASSIGNMENT_ACTIONS — Supply the payroll action context and assignment action records that determine which accumulation period applies.
• PER_TIME_PERIODS — Defines the payroll period boundaries used to translate an effective date into a valid start date.
• HR_SOFT_CODING_KEYFLEX — Supplies distribution and cost allocation context where soft coding affects the applicable calculation window.
• HR_ORGANIZATION_INFORMATION — Provides business group level configuration and organization attributes referenced during rule resolution.

Usage Notes

PAY_IN_EXC is an internal payroll engine utility rather than a public API intended for direct customization. It is invoked by payroll balance calculation logic and by concurrent processes that determine accumulation start dates during payroll runs, balance initialization, and year-end or half-year rollover processing. The ETRM metadata records no packaged callers (referenced by 0 other packages), indicating that its callers reside in form logic, concurrent program internals, or generated payroll code rather than in other PL/SQL packages. Custom developers seeking HYTD behavior should generally not call HYTD_START directly; instead they should rely on the standard balance and element processing that consumes these procedures, because the routines depend on valid payroll action and assignment action context that only the payroll engine reliably provides.