Search Results child_support_code

Overview

The view APPS.PAY_NZ_ASG_CAL_MTH_BAL_V is a New Zealand localisation object within the Oracle E-Business Suite Payroll (PAY) product. It presents, for each assignment, a calendar-month aggregation of payroll balance values that are required for New Zealand statutory reporting and returns — principally the Employer Monthly Schedule (EMS) and associated Inland Revenue Department (IRD) obligations. The view consolidates amounts collected through payroll run results and run result values, applies the appropriate balance feeds and scales, and exposes derived codes produced by the NZ tax package.

Its role in EBS is primarily as a reporting and integration source. External or custom reporting layers, concurrent programs, and interface extracts reference this view rather than reconstructing the aggregation logic against the underlying payroll tables. Because it performs the decode-and-sum logic for gross earnings, withholding payments, ACC-exempt earnings, PAYE, child support, student loan, and KiwiSaver components, it acts as a single authoritative projection of an assignment's monthly NZ payroll position.

The specific search term child_support_code is directly relevant here: the view exposes a derived child support code column populated through the PAY_NZ_TAX.CHILD_SUPPORT_CODE function, alongside the summed child support deduction amount.

Underlying Base Objects

The view is defined over a set of APPS synonyms resolving to the following base objects, all documented in the 12.2.2 metadata:

• FND_SESSIONS — supplies the current session context via USERENV('SESSIONID').
• PER_ALL_ASSIGNMENTS_F — the assignment driving each row and the join to soft coding.
• HR_SOFT_CODING_KEYFLEX — provides the key flexflex segment (SEGMENT1) used to identify payroll/soft-coding context.
• PAY_BALANCE_TYPES — the balance definition (BALANCE_NAME) that drives each DECODE branch.
• PAY_BALANCE_FEEDS_F — provides the feed and its SCALE multiplier.
• PAY_RUN_RESULTS and PAY_RUN_RESULT_VALUES — the run result header and its numeric RESULT_VALUE.
• PAY_INPUT_VALUES_F — links feeds to input values (INPUT_VALUE_ID).
• PAY_ASSIGNMENT_ACTIONS and PAY_PAYROLL_ACTIONS — the assignment and payroll action context through which runs are scoped.
• PAY_NZ_TAX (package) — supplies the NZ-specific derived functions CHILD_SUPPORT_CODE and EXTRA_EMOL_AT_LOW_TAX_RATE.

Key Columns

• ASSIGNMENT_ID — the assignment identifier from PER_ALL_ASSIGNMENTS_F.
• SEGMENT1 — soft coding key flex segment from HR_SOFT_CODING_KEYFLEX.
• EFFECTIVE_DATE — the effective date from the session context.
• Gross earnings aggregate — FLOOR(SUM(...)) over GROSS EARNINGS, WITHHOLDING PAYMENTS RECORD, and RETRO ORDINARY TAXABLE EARNINGS, each scaled by FEED.SCALE.
• ACC-exempt earnings aggregate — sum of EARNINGS NOT LIABLE FOR ACC EP and RETRO EARNINGS NOT LIABLE FOR ACC EP.
• Extra emolument low-rate flag — SUBSTR(PAY_NZ_TAX.EXTRA_EMOL_AT_LOW_TAX_RATE(...),1,1).
• PAYE deduction aggregate — PAYE TAX DEDUCTIONS, WITHHOLDING TAX DEDUCTIONS RECORD, RETRO PAYE TAX DEDUCTIONS.
• Child support amount — sum of CHILD SUPPORT DEDUCTIONS multiplied by FEED.SCALE.
• CHILD_SUPPORT_CODE — the first character of PAY_NZ_TAX.CHILD_SUPPORT_CODE(ASSIGNMENT_ID, EFFECTIVE_DATE), the NZ child support deduction code for the assignment.
• Student loan aggregate — STUDENT LOAN DEDUCTIONS and RETRO STUDENT LOAN DEDUCTIONS (added for Bug 5846247).
• KiwiSaver employee and employer contribution aggregates.

Common Use Cases and Queries

Typical uses include preparing NZ EMS/IRD extracts, reconciling child support and student loan deductions, and validating KiwiSaver contributions by assignment for a calendar month.

SELECT assignment_id,
       segment1,
       effective_date,
       child_support_code
  FROM apps.pay_nz_asg_cal_mth_bal_v;

To isolate assignments with an active child support code:

SELECT assignment_id, segment1, child_support_code
  FROM apps.pay_nz_asg_cal_mth_bal_v
 WHERE child_support_code IS NOT NULL
   AND child_support_code <> '0';

Because the view depends on FND_SESSIONS and the current session identifier, it must be queried within an initialized EBS session (for example, from a concurrent program or a session-bound client) so that SES.SESSION_ID = USERENV('SESSIONID') resolves correctly.