Search Results half_month_start

Overview

APPS.PAY_NZ_TAX is a New Zealand country-specific payroll utility package within the Oracle E-Business Suite Payroll (PAY) product family. It consolidates the PL/SQL tax calculation logic required for New Zealand statutory reporting and withholding, providing date-boundary helpers and payroll status interrogation functions that regional payroll processes, element calculations, and regulatory reports depend upon. The package is declared AUTHID CURRENT_USER and was first created on 22 July 1999 by JTURNER, with the half-month functions added on 26 July 1999 and child support / extra emolument functions added the following day. The most recent change recorded in the header, dated 20 November 2002 (reference 2665496, KAVERMA), added DBI driver commands; the source therefore predates the multi-org and OAF eras and has remained stable through release 12.1.1 and 12.2.2.

The package is classified as OTHER in the ETRM metadata, meaning Oracle does not publish it as a supported public API. It is nonetheless a documented, schema-resident object owned by APPS and is referenced by four other packages, indicating it sits within a wider NZ payroll dependency chain rather than being a standalone utility.

Key Procedures and Functions

Five documented functions are exposed by the package specification:

• OTHER_ASG_EXISTS — Determines whether a current assignment other than the one supplied already exists for the same employee, returning a VARCHAR2 flag. It supports headcount and duplicate-assignment validation during NZ payroll processing.
• HALF_MONTH_START — Returns the start date of the half-month period containing the supplied effective date. As documented in the source comments, NZ month halves for tax reporting purposes are defined as the 1st to the 15th and the 16th to the last day of the month. This is the function associated with the search term half_month_start.
• HALF_MONTH_END — Returns the corresponding end date of the half-month period containing the effective date, using the same 1–15 / 16–end-of-month boundary convention.
• EXTRA_EMOL_AT_LOW_TAX_RATE — Determines whether any extra emoluments for the assignment and effective date have been taxed at the lower (secondary) rate. It returns a VARCHAR2 indicator.
• CHILD_SUPPORT_CODE — Derives the child support variation code applicable to the assignment at the given effective date, returning a VARCHAR2.

The specification declares PRAGMA RESTRICT_REFERENCES with WNDS, WNPS on the functions, asserting that they write neither database state nor package state. This makes them safe for use inside SQL statements and view definitions.

Tables Accessed

The documented table references reflect both the assignment/date resolution logic and the payroll results interrogation performed by the status functions:

• PER_ALL_ASSIGNMENTS_F, PAY_ASSIGNMENT_ACTIONS — assignment existence, current-assignment checks, and effective-dated assignment context.
• PER_TIME_PERIODS — payroll period definitions used to anchor half-month and effective-date boundaries.
• PAY_ELEMENT_TYPES_F, PAY_INPUT_VALUES_F — element classification and input value metadata, required to identify extra emoluments and their tax treatment.
• PAY_RUN_RESULTS, PAY_RUN_RESULT_VALUES — actual calculated results used to determine whether emoluments were taxed at the lower rate and to derive child support variation data.
• PAY_PAYROLL_ACTIONS — payroll action context for the run in which results were produced.
• FND_SESSIONS — Oracle Application Object Library session context, consistent with standard EBS session handling.

All tables are referenced through APPS synonyms rather than fully qualified schema names, so the package executes under the privileges of the calling APPS session.

Usage Notes

PAY_NZ_TAX is invoked indirectly rather than through a dedicated form or concurrent program. The half-month functions are called from NZ tax reporting and payroll calculation logic wherever a date must be mapped to a statutory half-month window. EXTRA_EMOL_AT_LOW_TAX_RATE and CHILD_SUPPORT_CODE are consumed by payroll element fast formulas, report logic, and other PL/SQL packages that need to classify an assignment's tax position before computing deductions. Because four packages reference it, changes to its behaviour carry downstream risk.

Custom code may call the two half-month functions safely, since they are pure date functions with no table access and are declared with restrict-references pragmas. Calls to the remaining functions should be treated as read-only queries against assignment, element, and run result data and should be executed in an APPS session context; the package is not intended for direct invocation from external schemas.