Search Results gross_earnings




Overview
Explore in AI Chat

Overview

PAY_NZ_ER_CAL_MTH_BAL_V is a New Zealand localisation view owned by the APPS schema in Oracle E-Business Suite (12.1.1 and 12.2.2). It is catalogued under the PAY — Payroll product and is documented as VALID in the ETRM repository. The view aggregates calendar-month payroll balance information for New Zealand employers, consolidating assignment-level balances into a single organisation-wide monthly summary. Because the user search term is "gross_earnings", this view is directly relevant: GROSS_EARNINGS is the primary aggregated measure produced by the view.

Functionally, the view acts as an employer-level ("ER") reporting layer over the more granular PAY_NZ_ASG_CAL_MTH_BAL_V (assignment calendar-month balances). It filters to New Zealand PAYE information element types and returns one row per organisation and effective date. It is therefore intended for statutory returns, reconciliation, and downstream integrations that require monthly aggregated New Zealand payroll totals rather than individual assignment detail.

Underlying Base Objects

The documented view text joins PAY_NZ_ASG_CAL_MTH_BAL_V to several base objects. The ETRM metadata lists the following referenced objects:

  • PAY_NZ_ASG_CAL_MTH_BAL_V (VIEW) — the assignment-level source of the aggregated balances.
  • PAY_ELEMENT_TYPES_F (SYNONYM) — restricts rows to the 'PAYE INFORMATION' and 'WITHHOLDING TAX INFORMATION RECORD' element types.
  • PAY_ASSIGNMENT_ACTIONS (SYNONYM), PAY_PAYROLL_ACTIONS (SYNONYM), PAY_RUN_RESULTS (SYNONYM) — resolve the latest valid payroll run result per assignment.
  • PER_ASSIGNMENTS_F (VIEW) — provides the latest effective assignment record per person.
  • FND_SESSIONS (SYNONYM) — supplies the effective date used for date-range logic.
  • PAY_NZ_TAX (PACKAGE), HR_GENERAL (PACKAGE), HR_SECURITY (PACKAGE) — supporting New Zealand tax calculations and security/date utilities.

The joins apply a "latest effective row" pattern: EXEC MAX on EFFECTIVE_START_DATE for element types and assignments, and MAX on ASSIGNMENT_ACTION_ID for the payroll action, ensuring only the most current record within each session month is included.

Key Columns

The WHERE clause also enforces a non-negative net earnings condition: GROSS_EARNINGS minus (PAYE + Child Support + Student Loan) must be greater than or equal to zero, which suppresses anomalous negative-net records.

Common Use Cases and Queries

Typical scenarios include month-end New Zealand payroll reconciliation, statutory PAYE reporting, and extracts feeding general ledger or third-party payroll providers. A representative query follows:

  • SELECT organization_id, effective_date, gross_earnings, paye_deductions, kiwisaver_ee_contributions, kiwisaveer_er_contributions FROM apps.pay_nz_er_cal_mth_bal_v WHERE effective_date BETWEEN :start_date AND :end_date ORDER BY organization_id, effective_date;
  • SELECT gross_earnings FROM apps.pay_nz_er_cal_mth_bal_v WHERE organization_id = :org_id AND effective_date = :month_end;
  • Aggregate net pay for a period: SELECT organization_id, SUM(gross_earnings - (paye_deductions + child_support_deductions + student_loan_deductions)) net_pay FROM apps.pay_nz_er_cal_mth_bal_v GROUP BY organization_id;

Because the view relies on FND_SESSIONS for its effective date, queries executed outside an active payroll session context may return no rows; session context should be established before use in custom reports or integrations.