Search Results pay_za_calendars_pkg




Overview
Explore in AI Chat

Overview

PAY_ZA_CALENDARS_PKG is an Oracle E-Business Suite package body owned by the APPS schema that supports South African (ZA) payroll calendar configuration. Its purpose is to generate and maintain the time periods, tax years, tax quarters, and fiscal calendars required by the South African localization of Oracle Payroll. Because South African statutory payroll reporting depends on correctly aligned tax years (March to February), fiscal years, and payroll month-ends, this package provides the deterministic date arithmetic and calendar seeding logic that the rest of the ZA payroll configuration relies upon. The package is classified as OTHER and is documented as VALID, but it is not referenced by any other database object, indicating that it functions as a maintenance or utility package invoked during setup and period generation rather than as a runtime API consumed by other PL/SQL units.

Key Procedures and Functions

The package exposes fourteen documented procedures and functions. DO acts as the primary driver or entry point that orchestrates the calendar creation process. CREATE_CALENDAR performs the general calendar creation logic, while CREATE_ZA_PAYROLL_MONTH_ENDS establishes the payroll month-end dates specific to the South African localization. Several routines support date and period derivation: RETRIEVE_TAX_YEAR_START and RETRIEVE_FISCAL_YEAR_START resolve the beginning dates of the applicable tax and fiscal years, and GENERATE_FISCAL_MONTH_START produces fiscal month start dates. A set of date-arithmetic helpers supports period generation: NEXT_LOWER_DAY, ADD_MULTIPLE_OF_BASE, NEXT_SEMI_MONTH, and PREV_SEMI_MONTH compute relative dates and semi-monthly boundaries. The remaining routines seed specific calendar structures: CREATE_ZA_EMPLOYEE_TAX_YEARS, CREATE_ZA_EMPLOYEE_CAL_YEARS, CREATE_ZA_TAX_QUARTERS, and CREATE_ZA_PERIOD_NUMBERS create tax year, calendar year, tax quarter, and period numbering records respectively. No parameter lists are documented and none should be assumed.

Tables Accessed

The package reads and writes the core Oracle HRMS and Payroll date and calendar tables through APPS synonyms. PER_TIME_PERIODS stores the individual time periods that make up payroll calendars, and PER_TIME_PERIOD_TYPES defines the period types (such as monthly and semi-monthly) that govern how those periods are generated. PAY_LEGISLATION_RULES supplies the legislative rule definitions that determine the correct calendar behaviour for the South African legislation. HR_ORGANIZATION_INFORMATION provides organization-level configuration, most likely the business group and related classification details required to scope calendar generation to the correct organization. Additional dependencies include PAY_PAYROLLS_F for payroll definitions, FND_DATE and FND_PROFILE for date conversion and profile option retrieval, and HR_UTILITY for standard HRMS utility logic.

Usage Notes

Because the package is not referenced by any other database object, it is not intended to be called from other PL/SQL APIs. It is typically invoked during South African payroll implementation and configuration, either directly as a setup utility or via a concurrent program, to seed and refresh the payroll calendar, tax year, tax quarter, and period numbering data. Re-running periods should follow the same conventions as other ZA localization utilities and should be performed with awareness of any existing generated periods. Custom code requiring the same date logic should call the documented procedures rather than duplicating the fiscal and tax year derivation rules.