@markwharton/eh-payroll 3.3.0 → 3.4.0

package/README.md

@@ -71,6 +71,10 @@ if (groupResult.ok) console.log(groupResult.data); // PayrollEmployeeGroup[]
 const hoursResult = await client.getStandardHours(employeeId);
 if (hoursResult.ok) console.log(hoursResult.data); // PayrollStandardHours
 
+// Get leave balances for an employee
+const balanceResult = await client.getEmployeeLeaveBalances(employeeId);
+if (balanceResult.ok) console.log(balanceResult.data); // PayrollLeaveBalance[]
+
 ```
 
 ## Result Pattern
@@ -86,8 +90,13 @@ All methods return `Result<T>` — see [api-core Result Pattern](../../README.md
 | `getEmployee(employeeId)` | `number` | `Result<PayrollAuEmployee>` |
 | `getEmployeeImage(employeeId)` | `number` | `Result<PayrollEmployeeImage>` |
 | `getStandardHours(employeeId)` | `number` | `Result<PayrollStandardHours>` |
+| `getEmployeeLeaveBalances(employeeId, options?)` | `number, PayrollLeaveBalanceOptions?` | `Result<PayrollLeaveBalance[]>` |
+| `getUnavailabilities(options?)` | `PayrollUnavailabilityOptions?` | `Result<PayrollUnavailability[]>` |
 | `getLocations()` | — | `Result<PayrollLocation[]>` |
 | `getEmployeeGroups()` | — | `Result<PayrollEmployeeGroup[]>` |
+| `getPublicHolidays(options?)` | `PayrollPublicHolidayOptions?` | `Result<PayrollPublicHoliday[]>` |
+| `getWorkTypes()` | — | `Result<PayrollWorkType[]>` |
+| `getLeaveCategories()` | — | `Result<PayrollLeaveCategory[]>` |
 | `getRosterShifts(from, to, options?)` | `string, string, PayrollRosterShiftOptions?` | `Result<PayrollRosterShift[]>` |
 | `getKiosks()` | — | `Result<PayrollKiosk[]>` |
 | `getKioskStaff(kioskId, options?)` | `number, PayrollKioskStaffOptions?` | `Result<PayrollKioskEmployee[]>` |
@@ -131,6 +140,49 @@ Returns leave requests for a specific employee using the per-employee endpoint w
 | `fromDate` | `string` | Start date filter (ISO 8601) |
 | `toDate` | `string` | End date filter (ISO 8601) |
 
+### `getEmployeeLeaveBalances()`
+
+Returns the accrued leave balance per category for an employee. The balance is the "live" value calculated from pay runs — updated after each pay run is processed. Supports an optional `asAtDate` parameter for point-in-time balance queries.
+
+**`PayrollLeaveBalanceOptions`:**
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `asAtDate` | `string` | Point-in-time date for balance query (ISO 8601 date-time) |
+
+### `getUnavailabilities()`
+
+Returns unavailability records for the business. The endpoint returns a flat array (not paginated).
+
+**Unavailabilities are time-series data** — always use `fromDate`/`toDate` filters to bound the result set.
+
+**`PayrollUnavailabilityOptions`:**
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `fromDate` | `string` | Start date filter (YYYY-MM-DD) |
+| `toDate` | `string` | End date filter (YYYY-MM-DD) |
+| `employeeId` | `number` | Filter by employee ID |
+| `defaultLocationId` | `number` | Filter by default location ID |
+
+### `getPublicHolidays()`
+
+Returns public holidays for the business.
+
+**`PayrollPublicHolidayOptions`:**
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `year` | `number` | Filter by year |
+
+### `getWorkTypes()`
+
+Returns all work types for the business. Automatically paginates through all results.
+
+### `getLeaveCategories()`
+
+Returns all leave categories for the business. Automatically paginates through all results.
+
 ### `getRosterShifts()`
 
 Automatically paginates through all results (100 per page). Returns the complete set of roster shifts for the requested date range. All filter options are applied server-side, reducing the number of results and pages fetched.

package/dist/client.d.ts

@@ -6,7 +6,7 @@
  *
  * @see https://api.keypay.com.au/
  */
-import type { PayrollConfig, PayrollLeaveRequest, PayrollLeaveRequestOptions, PayrollEmployeeLeaveRequestOptions, PayrollEmployeeOptions, PayrollStandardHours, PayrollLocation, PayrollEmployeeGroup, PayrollRosterShift, PayrollRosterShiftOptions, PayrollKiosk, PayrollKioskEmployee, PayrollKioskStaffOptions, PayrollEmployeeImage } from './types.js';
+import type { PayrollConfig, PayrollLeaveRequest, PayrollLeaveRequestOptions, PayrollEmployeeLeaveRequestOptions, PayrollEmployeeOptions, PayrollStandardHours, PayrollLeaveBalance, PayrollLeaveBalanceOptions, PayrollPublicHoliday, PayrollPublicHolidayOptions, PayrollWorkType, PayrollLeaveCategory, PayrollUnavailability, PayrollUnavailabilityOptions, PayrollLocation, PayrollEmployeeGroup, PayrollRosterShift, PayrollRosterShiftOptions, PayrollKiosk, PayrollKioskEmployee, PayrollKioskStaffOptions, PayrollEmployeeImage } from './types.js';
 import type { PayrollEmployee } from './employee-types.generated.js';
 import type { Result } from '@markwharton/api-core';
 /**
@@ -129,6 +129,27 @@ export declare class PayrollClient {
      * Get standard hours for an employee (includes FTE value)
      */
     getStandardHours(employeeId: number): Promise<Result<PayrollStandardHours>>;
+    /**
+     * Get leave balances for an employee
+     *
+     * Returns the accrued leave balance per category. The balance is the "live"
+     * value calculated from pay runs — updated after each pay run is processed.
+     *
+     * @param employeeId - Employee identifier
+     * @param options - Optional query parameters (e.g., asAtDate for point-in-time balance)
+     * @see https://api.keypay.com.au/australia/reference/employee/leave-balances--get-leave-balances.html
+     */
+    getEmployeeLeaveBalances(employeeId: number, options?: PayrollLeaveBalanceOptions): Promise<Result<PayrollLeaveBalance[]>>;
+    /**
+     * Get unavailabilities
+     *
+     * Returns unavailability records for the business, with optional filters.
+     * The endpoint returns a flat array (not paginated).
+     *
+     * **Unavailabilities are time-series data** — always use fromDate/toDate
+     * filters to bound the result set.
+     */
+    getUnavailabilities(options?: PayrollUnavailabilityOptions): Promise<Result<PayrollUnavailability[]>>;
     /**
      * Get all business locations
      */
@@ -137,6 +158,20 @@ export declare class PayrollClient {
      * Get all employee groups
      */
     getEmployeeGroups(): Promise<Result<PayrollEmployeeGroup[]>>;
+    /**
+     * Get public holidays for the business
+     *
+     * @param options - Optional filters (year)
+     */
+    getPublicHolidays(options?: PayrollPublicHolidayOptions): Promise<Result<PayrollPublicHoliday[]>>;
+    /**
+     * Get all work types for the business
+     */
+    getWorkTypes(): Promise<Result<PayrollWorkType[]>>;
+    /**
+     * Get all leave categories for the business
+     */
+    getLeaveCategories(): Promise<Result<PayrollLeaveCategory[]>>;
     /**
      * Get roster shifts for a date range
      *

package/dist/client.js

@@ -78,6 +78,7 @@ export class PayrollClient {
         this.cache?.invalidate('employees');
         this.cache?.invalidate('employee:');
         this.cache?.invalidate('standardhours:');
+        this.cache?.invalidate('leavebalances:');
     }
     /**
      * Invalidate cached leave request data (business-level and per-employee).
@@ -365,6 +366,69 @@ export class PayrollClient {
         }, this.restrictedPersistOpt);
     }
     // ============================================================================
+    // Leave Balances
+    // ============================================================================
+    /**
+     * Get leave balances for an employee
+     *
+     * Returns the accrued leave balance per category. The balance is the "live"
+     * value calculated from pay runs — updated after each pay run is processed.
+     *
+     * @param employeeId - Employee identifier
+     * @param options - Optional query parameters (e.g., asAtDate for point-in-time balance)
+     * @see https://api.keypay.com.au/australia/reference/employee/leave-balances--get-leave-balances.html
+     */
+    async getEmployeeLeaveBalances(employeeId, options) {
+        return this.cached(`leavebalances:${employeeId}`, this.cacheTtl.standardHoursTtl, async () => {
+            const params = options?.asAtDate ? new URLSearchParams({ asAtDate: options.asAtDate }) : undefined;
+            const url = this.businessUrl(`employee/${employeeId}/leavebalances`, params);
+            return this.fetchAndParse(url, async (r) => {
+                return (await r.json())
+                    .map(item => pickFields(item, ENTITIES.PayrollLeaveBalance.fields));
+            });
+        }, this.restrictedPersistOpt);
+    }
+    // ============================================================================
+    // Unavailability
+    // ============================================================================
+    /**
+     * Get unavailabilities
+     *
+     * Returns unavailability records for the business, with optional filters.
+     * The endpoint returns a flat array (not paginated).
+     *
+     * **Unavailabilities are time-series data** — always use fromDate/toDate
+     * filters to bound the result set.
+     */
+    async getUnavailabilities(options) {
+        const parts = ['unavailabilities'];
+        if (options?.fromDate)
+            parts.push(`from:${options.fromDate}`);
+        if (options?.toDate)
+            parts.push(`to:${options.toDate}`);
+        if (options?.employeeId != null)
+            parts.push(`eid:${options.employeeId}`);
+        if (options?.defaultLocationId != null)
+            parts.push(`lid:${options.defaultLocationId}`);
+        const cacheKey = parts.join(':');
+        return this.cached(cacheKey, this.cacheTtl.leaveRequestsTtl, async () => {
+            const params = new URLSearchParams();
+            if (options?.fromDate)
+                params.set('FromDate', options.fromDate);
+            if (options?.toDate)
+                params.set('ToDate', options.toDate);
+            if (options?.employeeId != null)
+                params.set('EmployeeId', String(options.employeeId));
+            if (options?.defaultLocationId != null)
+                params.set('DefaultLocationId', String(options.defaultLocationId));
+            const url = this.businessUrl(ENTITIES.PayrollUnavailability.path, params);
+            return this.fetchAndParse(url, async (r) => {
+                return (await r.json())
+                    .map(item => pickFields(item, ENTITIES.PayrollUnavailability.fields));
+            });
+        }, this.restrictedPersistOpt);
+    }
+    // ============================================================================
     // Locations
     // ============================================================================
     /**
@@ -395,6 +459,55 @@ export class PayrollClient {
         });
     }
     // ============================================================================
+    // Public Holidays
+    // ============================================================================
+    /**
+     * Get public holidays for the business
+     *
+     * @param options - Optional filters (year)
+     */
+    async getPublicHolidays(options) {
+        const cacheKey = options?.year ? `publicholidays:${options.year}` : 'publicholidays';
+        return this.cached(cacheKey, this.cacheTtl.locationsTtl, async () => {
+            const params = options?.year ? new URLSearchParams({ year: String(options.year) }) : undefined;
+            const url = this.businessUrl(ENTITIES.PayrollPublicHoliday.path, params);
+            return this.fetchAndParse(url, async (r) => {
+                return (await r.json())
+                    .map(item => pickFields(item, ENTITIES.PayrollPublicHoliday.fields));
+            });
+        });
+    }
+    // ============================================================================
+    // Work Types
+    // ============================================================================
+    /**
+     * Get all work types for the business
+     */
+    async getWorkTypes() {
+        return this.cached('worktypes', this.cacheTtl.locationsTtl, () => {
+            const params = new URLSearchParams({ '$top': String(DEFAULT_PAGE_SIZE) });
+            return this.fetchPaginated((skip) => {
+                params.set('$skip', String(skip));
+                return this.businessUrl(ENTITIES.PayrollWorkType.path, params);
+            }, ENTITIES.PayrollWorkType.fields);
+        });
+    }
+    // ============================================================================
+    // Leave Categories
+    // ============================================================================
+    /**
+     * Get all leave categories for the business
+     */
+    async getLeaveCategories() {
+        return this.cached('leavecategories', this.cacheTtl.locationsTtl, () => {
+            const params = new URLSearchParams({ '$top': String(DEFAULT_PAGE_SIZE) });
+            return this.fetchPaginated((skip) => {
+                params.set('$skip', String(skip));
+                return this.businessUrl(ENTITIES.PayrollLeaveCategory.path, params);
+            }, ENTITIES.PayrollLeaveCategory.fields);
+        });
+    }
+    // ============================================================================
     // Roster Shifts
     // ============================================================================
     /**

package/dist/index.d.ts

@@ -20,8 +20,8 @@
  * ```
  */
 export { PayrollClient } from './client.js';
-export type { PayrollConfig, PayrollCacheConfig, PayrollRetryConfig, PayrollLeaveRequest, PayrollLeaveRequestOptions, PayrollLeaveRequestGroupBy, PayrollEmployeeLeaveRequestOptions, PayrollLeaveRequestStatus, PayrollEmployee, PayrollEmployeeStatus, PayrollLeaveAccrualStartDateType, PayrollCloselyHeldReporting, PayrollMedicareLevySurchargeWithholdingTier, PayrollSingleTouchPayrollCategory, PayrollTaxCategory, PayrollEmployeeOptions, PayrollStandardHours, PayrollLocation, PayrollEmployeeGroup, PayrollRosterShift, PayrollRosterShiftOptions, PayrollShiftStatus, PayrollAttendanceStatus, PayrollKiosk, PayrollKioskEmployee, PayrollKioskStaffOptions, PayrollEmployeeImage, } from './types.js';
-export { PAYROLL_EMPLOYEE_FIELDS, PAYROLL_LEAVE_REQUEST_FIELDS, PAYROLL_LOCATION_FIELDS, PAYROLL_EMPLOYEE_GROUP_FIELDS, PAYROLL_ROSTER_SHIFT_FIELDS, PAYROLL_KIOSK_FIELDS, PAYROLL_KIOSK_EMPLOYEE_FIELDS, ENTITIES, } from './types.js';
+export type { PayrollConfig, PayrollCacheConfig, PayrollRetryConfig, PayrollLeaveRequest, PayrollLeaveRequestOptions, PayrollLeaveRequestGroupBy, PayrollEmployeeLeaveRequestOptions, PayrollLeaveRequestStatus, PayrollEmployee, PayrollEmployeeStatus, PayrollLeaveAccrualStartDateType, PayrollCloselyHeldReporting, PayrollMedicareLevySurchargeWithholdingTier, PayrollSingleTouchPayrollCategory, PayrollTaxCategory, PayrollEmployeeOptions, PayrollStandardHours, PayrollLeaveBalance, PayrollLeaveBalanceOptions, PayrollLeaveBalanceUnitType, PayrollPublicHoliday, PayrollPublicHolidayOptions, PayrollWorkType, PayrollEmploymentType, PayrollWorkTypeMappingType, PayrollLeaveCategory, PayrollLeaveCategoryUnitType, PayrollLeaveUnitType, PayrollLeaveCategoryType, PayrollUnavailability, PayrollUnavailabilityOptions, PayrollDayOfWeek, PayrollLocation, PayrollEmployeeGroup, PayrollRosterShift, PayrollRosterShiftOptions, PayrollShiftStatus, PayrollAttendanceStatus, PayrollKiosk, PayrollKioskEmployee, PayrollKioskStaffOptions, PayrollEmployeeImage, } from './types.js';
+export { PAYROLL_EMPLOYEE_FIELDS, PAYROLL_LEAVE_REQUEST_FIELDS, PAYROLL_LEAVE_BALANCE_FIELDS, PAYROLL_PUBLIC_HOLIDAY_FIELDS, PAYROLL_WORK_TYPE_FIELDS, PAYROLL_LEAVE_CATEGORY_FIELDS, PAYROLL_UNAVAILABILITY_FIELDS, PAYROLL_LOCATION_FIELDS, PAYROLL_EMPLOYEE_GROUP_FIELDS, PAYROLL_ROSTER_SHIFT_FIELDS, PAYROLL_KIOSK_FIELDS, PAYROLL_KIOSK_EMPLOYEE_FIELDS, ENTITIES, } from './types.js';
 export type { AccessTier } from './types.js';
 export { METHOD_TIERS } from './types.js';
 export { buildBasicAuthHeader } from './utils.js';
@@ -32,8 +32,8 @@ export type { PayrollRegion } from './constants.js';
 export { PayrollError, parsePayrollErrorResponse } from './errors.js';
 export type { PayrollParsedError } from './errors.js';
 export { PayrollClient as EHClient } from './client.js';
-export type { PayrollConfig as EHConfig, PayrollCacheConfig as EHCacheConfig, PayrollRetryConfig as EHRetryConfig, PayrollLeaveRequest as EHLeaveRequest, PayrollLeaveRequestOptions as EHLeaveRequestOptions, PayrollLeaveRequestGroupBy as EHLeaveRequestGroupBy, PayrollEmployeeLeaveRequestOptions as EHEmployeeLeaveRequestOptions, PayrollLeaveRequestStatus as EHLeaveRequestStatus, PayrollEmployee as EHEmployee, PayrollEmployeeStatus as EHEmployeeStatus, PayrollLeaveAccrualStartDateType as EHLeaveAccrualStartDateType, PayrollCloselyHeldReporting as EHCloselyHeldReporting, PayrollMedicareLevySurchargeWithholdingTier as EHMedicareLevySurchargeWithholdingTier, PayrollSingleTouchPayrollCategory as EHSingleTouchPayrollCategory, PayrollTaxCategory as EHTaxCategory, PayrollEmployeeOptions as EHEmployeeOptions, PayrollStandardHours as EHStandardHours, PayrollLocation as EHLocation, PayrollEmployeeGroup as EHEmployeeGroup, PayrollRosterShift as EHRosterShift, PayrollRosterShiftOptions as EHRosterShiftOptions, PayrollShiftStatus as EHShiftStatus, PayrollAttendanceStatus as EHAttendanceStatus, PayrollKiosk as EHKiosk, PayrollKioskEmployee as EHKioskEmployee, PayrollKioskStaffOptions as EHKioskStaffOptions, PayrollEmployeeImage as EHEmployeeImage, } from './types.js';
-export { PAYROLL_EMPLOYEE_FIELDS as EMPLOYEE_FIELDS, PAYROLL_LEAVE_REQUEST_FIELDS as LEAVE_REQUEST_FIELDS, PAYROLL_LOCATION_FIELDS as LOCATION_FIELDS, PAYROLL_EMPLOYEE_GROUP_FIELDS as EMPLOYEE_GROUP_FIELDS, PAYROLL_ROSTER_SHIFT_FIELDS as ROSTER_SHIFT_FIELDS, PAYROLL_KIOSK_FIELDS as KIOSK_FIELDS, PAYROLL_KIOSK_EMPLOYEE_FIELDS as KIOSK_EMPLOYEE_FIELDS, } from './types.js';
+export type { PayrollConfig as EHConfig, PayrollCacheConfig as EHCacheConfig, PayrollRetryConfig as EHRetryConfig, PayrollLeaveRequest as EHLeaveRequest, PayrollLeaveRequestOptions as EHLeaveRequestOptions, PayrollLeaveRequestGroupBy as EHLeaveRequestGroupBy, PayrollEmployeeLeaveRequestOptions as EHEmployeeLeaveRequestOptions, PayrollLeaveRequestStatus as EHLeaveRequestStatus, PayrollEmployee as EHEmployee, PayrollEmployeeStatus as EHEmployeeStatus, PayrollLeaveAccrualStartDateType as EHLeaveAccrualStartDateType, PayrollCloselyHeldReporting as EHCloselyHeldReporting, PayrollMedicareLevySurchargeWithholdingTier as EHMedicareLevySurchargeWithholdingTier, PayrollSingleTouchPayrollCategory as EHSingleTouchPayrollCategory, PayrollTaxCategory as EHTaxCategory, PayrollEmployeeOptions as EHEmployeeOptions, PayrollStandardHours as EHStandardHours, PayrollLeaveBalance as EHLeaveBalance, PayrollLeaveBalanceOptions as EHLeaveBalanceOptions, PayrollLeaveBalanceUnitType as EHLeaveBalanceUnitType, PayrollPublicHoliday as EHPublicHoliday, PayrollPublicHolidayOptions as EHPublicHolidayOptions, PayrollWorkType as EHWorkType, PayrollEmploymentType as EHEmploymentType, PayrollWorkTypeMappingType as EHWorkTypeMappingType, PayrollLeaveCategory as EHLeaveCategory, PayrollLeaveCategoryUnitType as EHLeaveCategoryUnitType, PayrollLeaveUnitType as EHLeaveUnitType, PayrollLeaveCategoryType as EHLeaveCategoryType, PayrollUnavailability as EHUnavailability, PayrollUnavailabilityOptions as EHUnavailabilityOptions, PayrollDayOfWeek as EHDayOfWeek, PayrollLocation as EHLocation, PayrollEmployeeGroup as EHEmployeeGroup, PayrollRosterShift as EHRosterShift, PayrollRosterShiftOptions as EHRosterShiftOptions, PayrollShiftStatus as EHShiftStatus, PayrollAttendanceStatus as EHAttendanceStatus, PayrollKiosk as EHKiosk, PayrollKioskEmployee as EHKioskEmployee, PayrollKioskStaffOptions as EHKioskStaffOptions, PayrollEmployeeImage as EHEmployeeImage, } from './types.js';
+export { PAYROLL_EMPLOYEE_FIELDS as EMPLOYEE_FIELDS, PAYROLL_LEAVE_REQUEST_FIELDS as LEAVE_REQUEST_FIELDS, PAYROLL_LEAVE_BALANCE_FIELDS as LEAVE_BALANCE_FIELDS, PAYROLL_PUBLIC_HOLIDAY_FIELDS as PUBLIC_HOLIDAY_FIELDS, PAYROLL_WORK_TYPE_FIELDS as WORK_TYPE_FIELDS, PAYROLL_LEAVE_CATEGORY_FIELDS as LEAVE_CATEGORY_FIELDS, PAYROLL_UNAVAILABILITY_FIELDS as UNAVAILABILITY_FIELDS, PAYROLL_LOCATION_FIELDS as LOCATION_FIELDS, PAYROLL_EMPLOYEE_GROUP_FIELDS as EMPLOYEE_GROUP_FIELDS, PAYROLL_ROSTER_SHIFT_FIELDS as ROSTER_SHIFT_FIELDS, PAYROLL_KIOSK_FIELDS as KIOSK_FIELDS, PAYROLL_KIOSK_EMPLOYEE_FIELDS as KIOSK_EMPLOYEE_FIELDS, } from './types.js';
 export { PAYROLL_API_BASE as EH_API_BASE, PAYROLL_REGION_URLS as EH_REGION_URLS } from './constants.js';
 export type { PayrollRegion as EHRegion } from './constants.js';
 export { PayrollError as EHPayrollError, parsePayrollErrorResponse as parseEHPayrollErrorResponse } from './errors.js';

package/dist/index.js

@@ -22,7 +22,7 @@
 // Main client
 export { PayrollClient } from './client.js';
 // Field definitions (for pickFields)
-export { PAYROLL_EMPLOYEE_FIELDS, PAYROLL_LEAVE_REQUEST_FIELDS, PAYROLL_LOCATION_FIELDS, PAYROLL_EMPLOYEE_GROUP_FIELDS, PAYROLL_ROSTER_SHIFT_FIELDS, PAYROLL_KIOSK_FIELDS, PAYROLL_KIOSK_EMPLOYEE_FIELDS, ENTITIES, } from './types.js';
+export { PAYROLL_EMPLOYEE_FIELDS, PAYROLL_LEAVE_REQUEST_FIELDS, PAYROLL_LEAVE_BALANCE_FIELDS, PAYROLL_PUBLIC_HOLIDAY_FIELDS, PAYROLL_WORK_TYPE_FIELDS, PAYROLL_LEAVE_CATEGORY_FIELDS, PAYROLL_UNAVAILABILITY_FIELDS, PAYROLL_LOCATION_FIELDS, PAYROLL_EMPLOYEE_GROUP_FIELDS, PAYROLL_ROSTER_SHIFT_FIELDS, PAYROLL_KIOSK_FIELDS, PAYROLL_KIOSK_EMPLOYEE_FIELDS, ENTITIES, } from './types.js';
 export { METHOD_TIERS } from './types.js';
 // Utilities
 export { buildBasicAuthHeader } from './utils.js';
@@ -38,7 +38,7 @@ export { PayrollError, parsePayrollErrorResponse } from './errors.js';
 // Client
 export { PayrollClient as EHClient } from './client.js';
 // Field definitions
-export { PAYROLL_EMPLOYEE_FIELDS as EMPLOYEE_FIELDS, PAYROLL_LEAVE_REQUEST_FIELDS as LEAVE_REQUEST_FIELDS, PAYROLL_LOCATION_FIELDS as LOCATION_FIELDS, PAYROLL_EMPLOYEE_GROUP_FIELDS as EMPLOYEE_GROUP_FIELDS, PAYROLL_ROSTER_SHIFT_FIELDS as ROSTER_SHIFT_FIELDS, PAYROLL_KIOSK_FIELDS as KIOSK_FIELDS, PAYROLL_KIOSK_EMPLOYEE_FIELDS as KIOSK_EMPLOYEE_FIELDS, } from './types.js';
+export { PAYROLL_EMPLOYEE_FIELDS as EMPLOYEE_FIELDS, PAYROLL_LEAVE_REQUEST_FIELDS as LEAVE_REQUEST_FIELDS, PAYROLL_LEAVE_BALANCE_FIELDS as LEAVE_BALANCE_FIELDS, PAYROLL_PUBLIC_HOLIDAY_FIELDS as PUBLIC_HOLIDAY_FIELDS, PAYROLL_WORK_TYPE_FIELDS as WORK_TYPE_FIELDS, PAYROLL_LEAVE_CATEGORY_FIELDS as LEAVE_CATEGORY_FIELDS, PAYROLL_UNAVAILABILITY_FIELDS as UNAVAILABILITY_FIELDS, PAYROLL_LOCATION_FIELDS as LOCATION_FIELDS, PAYROLL_EMPLOYEE_GROUP_FIELDS as EMPLOYEE_GROUP_FIELDS, PAYROLL_ROSTER_SHIFT_FIELDS as ROSTER_SHIFT_FIELDS, PAYROLL_KIOSK_FIELDS as KIOSK_FIELDS, PAYROLL_KIOSK_EMPLOYEE_FIELDS as KIOSK_EMPLOYEE_FIELDS, } from './types.js';
 // Constants
 export { PAYROLL_API_BASE as EH_API_BASE, PAYROLL_REGION_URLS as EH_REGION_URLS } from './constants.js';
 // Errors

package/dist/types.d.ts

@@ -203,6 +203,173 @@ export interface PayrollLeaveRequest {
     /** Status: Approved, Pending, Rejected, Cancelled */
     status: string;
 }
+/**
+ * Leave balance for an employee
+ *
+ * From GET /business/{id}/employee/{eid}/leavebalances
+ * Fields from Swagger LeaveBalanceModel (Employee tag).
+ */
+export interface PayrollLeaveBalance {
+    /** Leave category ID */
+    leaveCategoryId: number;
+    /** Leave category name (e.g., "Annual Leave") */
+    leaveCategoryName: string;
+    /** Accrued leave balance amount */
+    accruedAmount: number;
+    /** Unit type for the balance */
+    unitType: PayrollLeaveBalanceUnitType;
+}
+/** Leave balance unit types */
+export type PayrollLeaveBalanceUnitType = 'Hours' | 'Days' | 'Weeks';
+/**
+ * Options for getEmployeeLeaveBalances
+ */
+export interface PayrollLeaveBalanceOptions {
+    /** Point-in-time date for the balance query (ISO 8601 date-time) */
+    asAtDate?: string;
+}
+/**
+ * Public holiday
+ *
+ * From GET /business/{id}/publicholiday
+ * Fields from Swagger PublicHolidayModel.
+ */
+export interface PayrollPublicHoliday {
+    /** Holiday ID */
+    id: number | null;
+    /** Holiday date (ISO 8601 datetime) */
+    date: string | null;
+    /** Holiday description (e.g., "Australia Day") */
+    description: string;
+    /** Applicable states (e.g., ["NSW", "VIC"]) */
+    states: string[];
+    /** Applicable location IDs */
+    locationIds: number[];
+    /** Additional note */
+    note: string | null;
+    /** Whether this is a system-generated holiday */
+    isSystem: boolean;
+    /** Override flag — marks a date as not a public holiday */
+    notAPublicHoliday: boolean;
+}
+/**
+ * Options for getPublicHolidays
+ */
+export interface PayrollPublicHolidayOptions {
+    /** Filter by year */
+    year?: number;
+}
+/**
+ * Work type
+ *
+ * From GET /business/{id}/worktype
+ * Fields from Swagger AuWorkTypeModel.
+ */
+export interface PayrollWorkType {
+    /** Work type ID */
+    id: number;
+    /** Work type name */
+    name: string;
+    /** Short code */
+    shortCode: string | null;
+    /** Applicable employment types */
+    employmentTypes: PayrollEmploymentType[];
+    /** Associated pay category ID */
+    payCategoryId: number | null;
+    /** Associated leave category ID */
+    leaveCategoryId: number | null;
+    /** Whether this work type accrues leave */
+    accruesLeave: boolean;
+    /** Mapping type */
+    mappingType: PayrollWorkTypeMappingType | null;
+    /** External identifier */
+    externalId: string | null;
+    /** Source system */
+    source: string | null;
+}
+/** Employment type values from Swagger AuEmploymentTypeEnum */
+export type PayrollEmploymentType = 'Unknown' | 'FullTime' | 'PartTime' | 'LabourHire' | 'SuperannuationIncomeStream' | 'Casual';
+/** Work type mapping type values from Swagger WorkTypeMappingType */
+export type PayrollWorkTypeMappingType = 'PayCategory' | 'LeaveCategory' | 'PrimaryPayCategory' | 'ShiftCondition';
+/**
+ * Leave category
+ *
+ * From GET /business/{id}/leavecategory
+ * Fields from Swagger AuLeaveCategoryModel.
+ */
+export interface PayrollLeaveCategory {
+    /** Leave category ID */
+    id: number;
+    /** Category name (e.g., "Annual Leave") */
+    name: string;
+    /** Entitlement units per year */
+    units: number;
+    /** Unit type for accrual (e.g., Days, Weeks) */
+    unitType: PayrollLeaveCategoryUnitType;
+    /** Unit type for leave taken */
+    leaveUnitType: PayrollLeaveUnitType;
+    /** Whether leave automatically accrues */
+    automaticallyAccrues: boolean;
+    /** Whether the category is private (hidden from employees) */
+    isPrivate: boolean;
+    /** Whether the balance is untracked */
+    isBalanceUntracked: boolean;
+    /** Whether to exclude from termination payout */
+    excludeFromTerminationPayout: boolean;
+    /** Leave category type */
+    leaveCategoryType: PayrollLeaveCategoryType;
+}
+/** Leave category unit type values from Swagger LeaveAllowanceUnitEnum */
+export type PayrollLeaveCategoryUnitType = 'Days' | 'Weeks' | 'HoursPerHourWorked' | 'HoursPerPayRun' | 'StandardDays' | 'StandardWeeks' | 'DayPerCalendarDay' | 'DayPerMonth';
+/** Leave unit type values from Swagger LeaveUnitTypeEnum */
+export type PayrollLeaveUnitType = 'Hours' | 'Days' | 'Weeks';
+/** Leave category type values from Swagger AuLeaveCategoryTypeEnum */
+export type PayrollLeaveCategoryType = 'Standard' | 'LongServiceLeave' | 'PersonalCarersLeave';
+/**
+ * Employee unavailability
+ *
+ * From GET /business/{id}/unavailability
+ * Fields from Swagger UnavailabilityModel.
+ */
+export interface PayrollUnavailability {
+    /** Unavailability ID */
+    id: number;
+    /** Employee ID */
+    employeeId: number;
+    /** Start date (ISO 8601 datetime) */
+    fromDate: string;
+    /** End date (ISO 8601 datetime) */
+    toDate: string | null;
+    /** Recurring end date (ISO 8601 datetime) */
+    endDate: string | null;
+    /** Reason for unavailability */
+    reason: string | null;
+    /** Whether this is a recurring unavailability */
+    recurring: boolean;
+    /** Day of week for recurring unavailability */
+    recurringDay: PayrollDayOfWeek | null;
+    /** Whether the unavailability covers the full day */
+    isAllDay: boolean;
+    /** Whether the unavailability is view-only */
+    viewOnly: boolean;
+}
+/** Day of week values from Swagger DayOfWeek */
+export type PayrollDayOfWeek = 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday';
+/**
+ * Options for getUnavailabilities
+ *
+ * All filters are passed server-side to the API.
+ */
+export interface PayrollUnavailabilityOptions {
+    /** Filter by start date (ISO 8601 date-time → API FromDate) */
+    fromDate?: string;
+    /** Filter by end date (ISO 8601 date-time → API ToDate) */
+    toDate?: string;
+    /** Filter by employee ID (→ API EmployeeId) */
+    employeeId?: number;
+    /** Filter by default location ID (→ API DefaultLocationId) */
+    defaultLocationId?: number;
+}
 /**
  * Employee profile image
  *
@@ -355,6 +522,85 @@ export declare const PAYROLL_LEAVE_REQUEST_FIELDS: {
     readonly notes: true;
     readonly status: true;
 };
+/** Fields for PayrollLeaveBalance — set false to exclude from API responses */
+export declare const PAYROLL_LEAVE_BALANCE_FIELDS: {
+    readonly leaveCategoryId: true;
+    readonly leaveCategoryName: true;
+    readonly accruedAmount: true;
+    readonly unitType: true;
+};
+/** Fields for PayrollPublicHoliday — set false to exclude from API responses */
+export declare const PAYROLL_PUBLIC_HOLIDAY_FIELDS: {
+    readonly id: true;
+    readonly date: true;
+    readonly description: true;
+    readonly states: true;
+    readonly locationIds: true;
+    readonly note: true;
+    readonly isSystem: true;
+    readonly notAPublicHoliday: true;
+    readonly mondayisedAlternativeToId: false;
+};
+/** Fields for PayrollWorkType — set false to exclude from API responses */
+export declare const PAYROLL_WORK_TYPE_FIELDS: {
+    readonly id: true;
+    readonly name: true;
+    readonly shortCode: true;
+    readonly employmentTypes: true;
+    readonly payCategoryId: true;
+    readonly leaveCategoryId: true;
+    readonly accruesLeave: true;
+    readonly mappingType: true;
+    readonly externalId: true;
+    readonly source: true;
+    readonly awardPackageId: false;
+    readonly awardPackageName: false;
+};
+/** Fields for PayrollLeaveCategory — set false to exclude from API responses */
+export declare const PAYROLL_LEAVE_CATEGORY_FIELDS: {
+    readonly id: true;
+    readonly name: true;
+    readonly units: true;
+    readonly unitType: true;
+    readonly leaveUnitType: true;
+    readonly automaticallyAccrues: true;
+    readonly isPrivate: true;
+    readonly isBalanceUntracked: true;
+    readonly excludeFromTerminationPayout: true;
+    readonly leaveCategoryType: true;
+    readonly contingentPeriod: false;
+    readonly entitlementPeriod: false;
+    readonly leaveLoading: false;
+    readonly leaveAccrualRule: false;
+    readonly transferOnTerminationToPayCategoryId: false;
+    readonly externalId: false;
+    readonly source: false;
+    readonly deductFromPrimaryPayCategory: false;
+    readonly deductFromPayCategoryId: false;
+    readonly transferToPayCategoryId: false;
+    readonly hideAccrualsOnPayslip: false;
+    readonly useDeductFromPayCategoryRate: false;
+    readonly isNamePrivate: false;
+    readonly payoutAsETP: false;
+    readonly accruesFirstPayRunPerPeriodOnly: false;
+    readonly preventNegativeBalanceUnpaidLeaveCategoryId: false;
+    readonly leaveEntitlement: false;
+};
+/** Fields for PayrollUnavailability — set false to exclude from API responses */
+export declare const PAYROLL_UNAVAILABILITY_FIELDS: {
+    readonly id: true;
+    readonly employeeId: true;
+    readonly fromDate: true;
+    readonly toDate: true;
+    readonly endDate: true;
+    readonly reason: true;
+    readonly recurring: true;
+    readonly recurringDay: true;
+    readonly isAllDay: true;
+    readonly viewOnly: true;
+    readonly recurringDays: false;
+    readonly recurringDaysCsv: false;
+};
 /** Fields for PayrollLocation — set false to exclude from API responses */
 export declare const PAYROLL_LOCATION_FIELDS: {
     readonly id: true;

package/dist/types.js

@@ -12,6 +12,42 @@ export const PAYROLL_LEAVE_REQUEST_FIELDS = {
     id: true, employeeId: true, leaveCategoryId: true, employee: true, leaveCategory: true,
     fromDate: true, toDate: true, totalHours: true, hoursApplied: true, notes: true, status: true,
 };
+/** Fields for PayrollLeaveBalance — set false to exclude from API responses */
+export const PAYROLL_LEAVE_BALANCE_FIELDS = {
+    leaveCategoryId: true, leaveCategoryName: true, accruedAmount: true, unitType: true,
+};
+/** Fields for PayrollPublicHoliday — set false to exclude from API responses */
+export const PAYROLL_PUBLIC_HOLIDAY_FIELDS = {
+    id: true, date: true, description: true, states: true, locationIds: true,
+    note: true, isSystem: true, notAPublicHoliday: true,
+    mondayisedAlternativeToId: false,
+};
+/** Fields for PayrollWorkType — set false to exclude from API responses */
+export const PAYROLL_WORK_TYPE_FIELDS = {
+    id: true, name: true, shortCode: true, employmentTypes: true,
+    payCategoryId: true, leaveCategoryId: true, accruesLeave: true, mappingType: true,
+    externalId: true, source: true,
+    awardPackageId: false, awardPackageName: false,
+};
+/** Fields for PayrollLeaveCategory — set false to exclude from API responses */
+export const PAYROLL_LEAVE_CATEGORY_FIELDS = {
+    id: true, name: true, units: true, unitType: true, leaveUnitType: true,
+    automaticallyAccrues: true, isPrivate: true, isBalanceUntracked: true,
+    excludeFromTerminationPayout: true, leaveCategoryType: true,
+    contingentPeriod: false, entitlementPeriod: false, leaveLoading: false,
+    leaveAccrualRule: false, transferOnTerminationToPayCategoryId: false,
+    externalId: false, source: false, deductFromPrimaryPayCategory: false,
+    deductFromPayCategoryId: false, transferToPayCategoryId: false,
+    hideAccrualsOnPayslip: false, useDeductFromPayCategoryRate: false,
+    isNamePrivate: false, payoutAsETP: false, accruesFirstPayRunPerPeriodOnly: false,
+    preventNegativeBalanceUnpaidLeaveCategoryId: false, leaveEntitlement: false,
+};
+/** Fields for PayrollUnavailability — set false to exclude from API responses */
+export const PAYROLL_UNAVAILABILITY_FIELDS = {
+    id: true, employeeId: true, fromDate: true, toDate: true, endDate: true,
+    reason: true, recurring: true, recurringDay: true, isAllDay: true, viewOnly: true,
+    recurringDays: false, recurringDaysCsv: false,
+};
 /** Fields for PayrollLocation — set false to exclude from API responses */
 export const PAYROLL_LOCATION_FIELDS = {
     id: true, parentId: true, name: true, externalId: true, source: true,
@@ -120,6 +156,11 @@ export const ENTITIES = {
     PayrollKioskEmployee: { fields: PAYROLL_KIOSK_EMPLOYEE_FIELDS, path: 'kiosk/{kioskId}/staff', apiRef: 'time-and-attendance/generic-time-and-attendance--get-staff' },
     PayrollEmployeeGroup: { fields: PAYROLL_EMPLOYEE_GROUP_FIELDS, path: 'employeegroup', apiRef: 'employee-groups/au-employee-group--get-groups' },
     PayrollStandardHours: { path: 'employee/{employeeId}/standardhours', apiRef: 'employee/au-employee-standard-hours--get' },
+    PayrollLeaveBalance: { fields: PAYROLL_LEAVE_BALANCE_FIELDS, path: 'employee/{employeeId}/leavebalances', apiRef: 'employee/leave-balances--get-leave-balances' },
+    PayrollPublicHoliday: { fields: PAYROLL_PUBLIC_HOLIDAY_FIELDS, path: 'publicholiday', apiRef: 'public-holiday/au-public-holiday--get-public-holidays-for-year' },
+    PayrollWorkType: { fields: PAYROLL_WORK_TYPE_FIELDS, path: 'worktype', apiRef: 'work-type/au-business-work-type--get-work-types' },
+    PayrollLeaveCategory: { fields: PAYROLL_LEAVE_CATEGORY_FIELDS, path: 'leavecategory', apiRef: 'leave-categories/au-leave-category--get-leave-categories' },
+    PayrollUnavailability: { fields: PAYROLL_UNAVAILABILITY_FIELDS, path: 'unavailability', apiRef: 'unavailability/unavailability--get' },
     EHEmployee: { fields: PAYROLL_EMPLOYEE_FIELDS, path: 'employee/unstructured', apiRef: 'employee/au-employee--get-employees', apiRefById: 'employee/au-employee--get-employee-by-id' },
     EHLeaveRequest: { fields: PAYROLL_LEAVE_REQUEST_FIELDS, path: 'leaverequest', apiRef: 'leave-requests/au-business-hours-leave-request--list-leave-requests' },
     EHEmployeeLeaveRequest: { fields: PAYROLL_LEAVE_REQUEST_FIELDS, path: 'employee/{employeeId}/leaverequest', apiRef: 'leave-requests/au-hours-leave-request--get-leave-requests' },
@@ -129,6 +170,11 @@ export const ENTITIES = {
     EHKioskEmployee: { fields: PAYROLL_KIOSK_EMPLOYEE_FIELDS, path: 'kiosk/{kioskId}/staff', apiRef: 'time-and-attendance/generic-time-and-attendance--get-staff' },
     EHEmployeeGroup: { fields: PAYROLL_EMPLOYEE_GROUP_FIELDS, path: 'employeegroup', apiRef: 'employee-groups/au-employee-group--get-groups' },
     EHStandardHours: { path: 'employee/{employeeId}/standardhours', apiRef: 'employee/au-employee-standard-hours--get' },
+    EHLeaveBalance: { fields: PAYROLL_LEAVE_BALANCE_FIELDS, path: 'employee/{employeeId}/leavebalances', apiRef: 'employee/leave-balances--get-leave-balances' },
+    EHPublicHoliday: { fields: PAYROLL_PUBLIC_HOLIDAY_FIELDS, path: 'publicholiday', apiRef: 'public-holiday/au-public-holiday--get-public-holidays-for-year' },
+    EHWorkType: { fields: PAYROLL_WORK_TYPE_FIELDS, path: 'worktype', apiRef: 'work-type/au-business-work-type--get-work-types' },
+    EHLeaveCategory: { fields: PAYROLL_LEAVE_CATEGORY_FIELDS, path: 'leavecategory', apiRef: 'leave-categories/au-leave-category--get-leave-categories' },
+    EHUnavailability: { fields: PAYROLL_UNAVAILABILITY_FIELDS, path: 'unavailability', apiRef: 'unavailability/unavailability--get' },
 };
 /**
  * Access tier for each data method.
@@ -144,10 +190,15 @@ export const METHOD_TIERS = {
     getKiosks: 'standard',
     getKioskStaff: 'standard',
     getRosterShifts: 'standard',
+    getPublicHolidays: 'standard',
+    getWorkTypes: 'standard',
+    getLeaveCategories: 'standard',
     getEmployees: 'restricted',
     getLeaveRequests: 'restricted',
     getEmployeeLeaveRequests: 'restricted',
     getEmployee: 'restricted',
     getEmployeeImage: 'restricted',
     getStandardHours: 'restricted',
+    getEmployeeLeaveBalances: 'restricted',
+    getUnavailabilities: 'restricted',
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@markwharton/eh-payroll",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "description": "Employment Hero Payroll API client",
   "type": "module",
   "main": "dist/index.js",