@markwharton/eh-payroll 2.5.0 → 2.6.0

package/README.md

@@ -75,25 +75,7 @@ if (hoursResult.ok) console.log(hoursResult.data); // EHStandardHours
 
 ## Result Pattern
 
-All methods return `Result<T>` objects rather than throwing exceptions. Always check `ok` before accessing `data`:
-
-```typescript
-interface Result<T> {
-  ok: boolean;
-  data?: T;       // present when ok is true
-  error?: string;  // present when ok is false
-  status?: number; // HTTP status code on error
-}
-```
-
-```typescript
-const result = await client.getEmployees();
-if (!result.ok) {
-  console.error(result.error, result.status);
-  return;
-}
-const employees = result.data;
-```
+All methods return `Result<T>` — see [api-core Result Pattern](../../README.md#result-pattern). Always check `ok` before accessing `data`.
 
 ## API Reference
 
@@ -109,14 +91,19 @@ const employees = result.data;
 | `getKiosks()` | — | `Result<EHKiosk[]>` |
 | `getKioskStaff(kioskId, options?)` | `number, EHKioskStaffOptions?` | `Result<EHKioskEmployee[]>` |
 | `getLeaveRequests(options?)` | `EHLeaveRequestOptions?` | `Result<EHLeaveRequest[]>` |
+| `getEmployeeLeaveRequests(employeeId, options?)` | `number, EHEmployeeLeaveRequestOptions?` | `Result<EHLeaveRequest[]>` |
+| `clearCache()` | — | `void` |
+| `invalidateEmployeeCache()` | — | `void` |
+| `invalidateLeaveRequestCache()` | — | `void` |
+| `invalidateRosterShiftCache()` | — | `void` |
+| `invalidateLocationCache()` | — | `void` |
+| `invalidateKioskCache()` | — | `void` |
 
 ### `getLeaveRequests()`
 
-Returns leave requests with all filters applied server-side. The business-level endpoint (`/api/v2/business/{businessId}/leaverequest`) returns a flat array — no pagination is available.
-
-**Leave requests are time-series data** — unlike employees and locations which remain relatively stable, leave requests grow continuously as new requests accumulate. Always use `fromDate`/`toDate` filters to bound the result set. Without date filters, the API returns the entire leave request history.
+Returns leave requests with all filters applied server-side. The business-level endpoint returns a flat array — no pagination.
 
-> **Note:** The Payroll API also provides a per-employee endpoint (`/api/v2/business/{businessId}/employee/{employeeId}/leaverequest`) with OData support (`$filter`, `$orderby`, `$top`, `$skip`). This client currently uses only the business-level endpoint.
+**Leave requests are time-series data** — unlike employees and locations which remain relatively stable, leave requests grow continuously. Always use `fromDate`/`toDate` filters to bound the result set.
 
 **`EHLeaveRequestOptions`:**
 
@@ -129,6 +116,18 @@ Returns leave requests with all filters applied server-side. The business-level
 | `leaveCategoryId` | `number` | Filter by leave category ID |
 | `locationId` | `number` | Filter by location ID |
 
+### `getEmployeeLeaveRequests()`
+
+Returns leave requests for a specific employee using the per-employee endpoint with OData pagination.
+
+**`EHEmployeeLeaveRequestOptions`:**
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `status` | `EHLeaveRequestStatus` | `'Approved'`, `'Pending'`, `'Rejected'`, or `'Cancelled'` |
+| `fromDate` | `string` | Start date filter (ISO 8601) |
+| `toDate` | `string` | End date filter (ISO 8601) |
+
 ### `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 { EHConfig, EHLeaveRequest, EHLeaveRequestOptions, EHEmployeeOptions, EHStandardHours, EHLocation, EHEmployeeGroup, EHRosterShift, EHRosterShiftOptions, EHKiosk, EHKioskEmployee, EHKioskStaffOptions } from './types.js';
+import type { EHConfig, EHLeaveRequest, EHLeaveRequestOptions, EHEmployeeLeaveRequestOptions, EHEmployeeOptions, EHStandardHours, EHLocation, EHEmployeeGroup, EHRosterShift, EHRosterShiftOptions, EHKiosk, EHKioskEmployee, EHKioskStaffOptions } from './types.js';
 import type { EHAuEmployee } from './employee-types.generated.js';
 import type { Result } from '@markwharton/api-core';
 /**
@@ -36,16 +36,32 @@ export declare class EHClient {
     constructor(config: EHConfig);
     /** Cache options for restricted-tier methods: skip persistent stores when persistRestricted is false. */
     private get restrictedPersistOpt();
-    /**
-     * Route through cache if enabled, otherwise call factory directly.
-     * Failed Results (ok === false) are never cached — transient errors
-     * shouldn't persist for the full TTL.
-     */
+    /** Route through cache if enabled, skipping failed Results. */
     private cached;
     /**
      * Clear all cached API responses.
      */
     clearCache(): void;
+    /**
+     * Invalidate cached employee data (employees, individual employees, standard hours).
+     */
+    invalidateEmployeeCache(): void;
+    /**
+     * Invalidate cached leave request data (business-level and per-employee).
+     */
+    invalidateLeaveRequestCache(): void;
+    /**
+     * Invalidate cached roster shift data.
+     */
+    invalidateRosterShiftCache(): void;
+    /**
+     * Invalidate cached location data.
+     */
+    invalidateLocationCache(): void;
+    /**
+     * Invalidate cached kiosk data (kiosks and kiosk staff).
+     */
+    invalidateKioskCache(): void;
     /**
      * Build a URL for a business-scoped endpoint.
      */
@@ -74,11 +90,11 @@ export declare class EHClient {
      */
     private fetchPaginated;
     /**
-     * Validate the API key by calling GET /user
+     * Validate the API key
      */
     validateApiKey(): Promise<Result<void>>;
     /**
-     * Get leave requests (server-side filtering)
+     * Get leave requests
      *
      * All filter options are passed as query parameters to the API.
      * The endpoint returns a flat array (not paginated).
@@ -87,7 +103,14 @@ export declare class EHClient {
      */
     getLeaveRequests(options?: EHLeaveRequestOptions): Promise<Result<EHLeaveRequest[]>>;
     /**
-     * Get all employees (unstructured format)
+     * Get leave requests for a specific employee
+     *
+     * Uses the per-employee endpoint with OData pagination.
+     * Optional filters for status and date range.
+     */
+    getEmployeeLeaveRequests(employeeId: number, options?: EHEmployeeLeaveRequestOptions): Promise<Result<EHLeaveRequest[]>>;
+    /**
+     * Get all employees
      */
     getEmployees(options?: EHEmployeeOptions): Promise<Result<EHAuEmployee[]>>;
     /**

package/dist/client.js

@@ -6,11 +6,11 @@
  *
  * @see https://api.keypay.com.au/
  */
-import { AU_EMPLOYEE_FIELDS, LEAVE_REQUEST_FIELDS, LOCATION_FIELDS, EMPLOYEE_GROUP_FIELDS, ROSTER_SHIFT_FIELDS, KIOSK_FIELDS, KIOSK_EMPLOYEE_FIELDS, } from './types.js';
+import { ENTITIES } from './types.js';
 import { buildBasicAuthHeader } from './utils.js';
 import { parseEHPayrollErrorResponse } from './errors.js';
 import { EH_API_BASE, EH_REGION_URLS } from './constants.js';
-import { TTLCache, pickFields, RateLimiter, getErrorMessage, fetchWithRetry, resolveRetryConfig, ok, okVoid, err } from '@markwharton/api-core';
+import { pickFields, RateLimiter, getErrorMessage, fetchWithRetry, resolveRetryConfig, ok, okVoid, err, cachedResult, fetchAndParseResponse, resolveClientCache } from '@markwharton/api-core';
 /** Default page size for paginated endpoints */
 const DEFAULT_PAGE_SIZE = 100;
 // ============================================================================
@@ -37,9 +37,7 @@ export class EHClient {
         this.baseUrl = config.baseUrl ?? (config.region ? EH_REGION_URLS[config.region] : EH_API_BASE);
         this.onRequest = config.onRequest;
         // Initialize cache if configured
-        if (config.cache || config.cacheInstance) {
-            this.cache = config.cacheInstance ?? new TTLCache();
-        }
+        this.cache = resolveClientCache(config);
         this.cacheTtl = {
             employeesTtl: config.cache?.employeesTtl ?? 300000,
             leaveRequestsTtl: config.cache?.leaveRequestsTtl ?? 120000,
@@ -63,18 +61,9 @@ export class EHClient {
     get restrictedPersistOpt() {
         return this.persistRestricted ? undefined : { persist: false };
     }
-    /**
-     * Route through cache if enabled, otherwise call factory directly.
-     * Failed Results (ok === false) are never cached — transient errors
-     * shouldn't persist for the full TTL.
-     */
-    async cached(key, ttlMs, factory, options) {
-        if (!this.cache)
-            return factory();
-        return this.cache.get(key, ttlMs, factory, {
-            ...options,
-            shouldCache: (data) => data.ok !== false,
-        });
+    /** Route through cache if enabled, skipping failed Results. */
+    cached(key, ttlMs, factory, options) {
+        return cachedResult(this.cache, key, ttlMs, factory, options);
     }
     /**
      * Clear all cached API responses.
@@ -82,6 +71,40 @@ export class EHClient {
     clearCache() {
         this.cache?.clear();
     }
+    /**
+     * Invalidate cached employee data (employees, individual employees, standard hours).
+     */
+    invalidateEmployeeCache() {
+        this.cache?.invalidate('employees');
+        this.cache?.invalidate('employee:');
+        this.cache?.invalidate('standardhours:');
+    }
+    /**
+     * Invalidate cached leave request data (business-level and per-employee).
+     */
+    invalidateLeaveRequestCache() {
+        this.cache?.invalidate('leaverequests');
+        this.cache?.invalidate('employeeleaverequests:');
+    }
+    /**
+     * Invalidate cached roster shift data.
+     */
+    invalidateRosterShiftCache() {
+        this.cache?.invalidate('rostershifts:');
+    }
+    /**
+     * Invalidate cached location data.
+     */
+    invalidateLocationCache() {
+        this.cache?.invalidate('locations');
+    }
+    /**
+     * Invalidate cached kiosk data (kiosks and kiosk staff).
+     */
+    invalidateKioskCache() {
+        this.cache?.invalidate('kiosks');
+        this.cache?.invalidate('kiosk:');
+    }
     /**
      * Build a URL for a business-scoped endpoint.
      */
@@ -126,19 +149,8 @@ export class EHClient {
     /**
      * Fetch a URL and parse the response, with standardized error handling.
      */
-    async fetchAndParse(url, parse, fetchOptions) {
-        try {
-            const response = await this.fetch(url, fetchOptions);
-            if (!response.ok) {
-                const errorText = await response.text();
-                const { message } = parseEHPayrollErrorResponse(errorText, response.status);
-                return err(message, response.status);
-            }
-            return ok(await parse(response));
-        }
-        catch (error) {
-            return err(getErrorMessage(error), 0);
-        }
+    fetchAndParse(url, parse, fetchOptions) {
+        return fetchAndParseResponse(() => this.fetch(url, fetchOptions), parse, parseEHPayrollErrorResponse);
     }
     /**
      * Fetch all pages of a paginated endpoint.
@@ -180,7 +192,7 @@ export class EHClient {
     // Validation
     // ============================================================================
     /**
-     * Validate the API key by calling GET /user
+     * Validate the API key
      */
     async validateApiKey() {
         const url = `${this.baseUrl}/user`;
@@ -202,7 +214,7 @@ export class EHClient {
     // Leave Requests
     // ============================================================================
     /**
-     * Get leave requests (server-side filtering)
+     * Get leave requests
      *
      * All filter options are passed as query parameters to the API.
      * The endpoint returns a flat array (not paginated).
@@ -238,18 +250,52 @@ export class EHClient {
                 params.set('LeaveCategoryId', String(options.leaveCategoryId));
             if (options?.locationId != null)
                 params.set('LocationId', String(options.locationId));
-            const url = this.businessUrl('leaverequest', params);
+            const url = this.businessUrl(ENTITIES.EHLeaveRequest.path, params);
             return this.fetchAndParse(url, async (r) => {
                 return (await r.json())
-                    .map(item => pickFields(item, LEAVE_REQUEST_FIELDS));
+                    .map(item => pickFields(item, ENTITIES.EHLeaveRequest.fields));
             });
         }, this.restrictedPersistOpt);
     }
+    /**
+     * Get leave requests for a specific employee
+     *
+     * Uses the per-employee endpoint with OData pagination.
+     * Optional filters for status and date range.
+     */
+    async getEmployeeLeaveRequests(employeeId, options) {
+        const parts = [`employeeleaverequests:${employeeId}`];
+        if (options?.status)
+            parts.push(`s:${options.status}`);
+        if (options?.fromDate)
+            parts.push(`from:${options.fromDate}`);
+        if (options?.toDate)
+            parts.push(`to:${options.toDate}`);
+        const cacheKey = parts.join(':');
+        const entityPath = ENTITIES.EHEmployeeLeaveRequest.path.replace('{employeeId}', String(employeeId));
+        return this.cached(cacheKey, this.cacheTtl.leaveRequestsTtl, () => {
+            const params = new URLSearchParams();
+            params.set('$top', String(DEFAULT_PAGE_SIZE));
+            const filterParts = [];
+            if (options?.status)
+                filterParts.push(`Status eq '${options.status}'`);
+            if (options?.fromDate)
+                filterParts.push(`FromDate ge datetime'${options.fromDate}'`);
+            if (options?.toDate)
+                filterParts.push(`ToDate le datetime'${options.toDate}'`);
+            if (filterParts.length > 0)
+                params.set('$filter', filterParts.join(' and '));
+            return this.fetchPaginated((skip) => {
+                params.set('$skip', String(skip));
+                return this.businessUrl(entityPath, params);
+            }, ENTITIES.EHEmployeeLeaveRequest.fields);
+        }, this.restrictedPersistOpt);
+    }
     // ============================================================================
     // Employees
     // ============================================================================
     /**
-     * Get all employees (unstructured format)
+     * Get all employees
      */
     async getEmployees(options) {
         const parts = ['employees'];
@@ -267,8 +313,8 @@ export class EHClient {
             params.set('$top', String(DEFAULT_PAGE_SIZE));
             return this.fetchPaginated((skip) => {
                 params.set('$skip', String(skip));
-                return `${this.baseUrl}/business/${this.businessId}/employee/unstructured?${params}`;
-            }, AU_EMPLOYEE_FIELDS);
+                return this.businessUrl(ENTITIES.EHAuEmployee.path, params);
+            }, ENTITIES.EHAuEmployee.fields);
         }, this.restrictedPersistOpt);
     }
     /**
@@ -276,9 +322,9 @@ export class EHClient {
      */
     async getEmployee(employeeId) {
         return this.cached(`employee:${employeeId}`, this.cacheTtl.employeesTtl, async () => {
-            const url = `${this.baseUrl}/business/${this.businessId}/employee/unstructured/${employeeId}`;
+            const url = this.businessUrl(`${ENTITIES.EHAuEmployee.path}/${employeeId}`);
             return this.fetchAndParse(url, async (r) => {
-                return pickFields(await r.json(), AU_EMPLOYEE_FIELDS);
+                return pickFields(await r.json(), ENTITIES.EHAuEmployee.fields);
             });
         }, this.restrictedPersistOpt);
     }
@@ -307,8 +353,8 @@ export class EHClient {
             const params = new URLSearchParams({ '$top': String(DEFAULT_PAGE_SIZE) });
             return this.fetchPaginated((skip) => {
                 params.set('$skip', String(skip));
-                return `${this.baseUrl}/business/${this.businessId}/location?${params}`;
-            }, LOCATION_FIELDS);
+                return this.businessUrl(ENTITIES.EHLocation.path, params);
+            }, ENTITIES.EHLocation.fields);
         });
     }
     // ============================================================================
@@ -322,8 +368,8 @@ export class EHClient {
             const params = new URLSearchParams({ '$top': String(DEFAULT_PAGE_SIZE) });
             return this.fetchPaginated((skip) => {
                 params.set('$skip', String(skip));
-                return `${this.baseUrl}/business/${this.businessId}/employeegroup?${params}`;
-            }, EMPLOYEE_GROUP_FIELDS);
+                return this.businessUrl(ENTITIES.EHEmployeeGroup.path, params);
+            }, ENTITIES.EHEmployeeGroup.fields);
         });
     }
     // ============================================================================
@@ -405,8 +451,8 @@ export class EHClient {
                 params.set('IncludeWarnings', 'true');
             return this.fetchPaginated((skip) => {
                 params.set('CurrentPage', String(skip / DEFAULT_PAGE_SIZE + 1));
-                return `${this.baseUrl}/business/${this.businessId}/rostershift?${params}`;
-            }, ROSTER_SHIFT_FIELDS);
+                return this.businessUrl(ENTITIES.EHRosterShift.path, params);
+            }, ENTITIES.EHRosterShift.fields);
         });
     }
     // ============================================================================
@@ -420,8 +466,8 @@ export class EHClient {
             const params = new URLSearchParams({ '$top': String(DEFAULT_PAGE_SIZE) });
             return this.fetchPaginated((skip) => {
                 params.set('$skip', String(skip));
-                return `${this.baseUrl}/business/${this.businessId}/kiosk?${params}`;
-            }, KIOSK_FIELDS);
+                return this.businessUrl(ENTITIES.EHKiosk.path, params);
+            }, ENTITIES.EHKiosk.fields);
         });
     }
     /**
@@ -439,10 +485,10 @@ export class EHClient {
             if (options?.restrictCurrentShiftsToCurrentKioskLocation) {
                 params.set('restrictCurrentShiftsToCurrentKioskLocation', 'true');
             }
-            const url = this.businessUrl(`kiosk/${kioskId}/staff`, params);
+            const url = this.businessUrl(ENTITIES.EHKioskEmployee.path.replace('{kioskId}', String(kioskId)), params);
             return this.fetchAndParse(url, async (r) => {
                 return (await r.json())
-                    .map(item => pickFields(item, KIOSK_EMPLOYEE_FIELDS));
+                    .map(item => pickFields(item, ENTITIES.EHKioskEmployee.fields));
             });
         });
     }

package/dist/index.d.ts

@@ -20,8 +20,8 @@
  * ```
  */
 export { EHClient } from './client.js';
-export type { EHConfig, EHCacheConfig, EHRetryConfig, EHLeaveRequest, EHLeaveRequestOptions, EHLeaveRequestStatus, EHEmployee, EHEmployeeOptions, EHStandardHours, EHLocation, EHEmployeeGroup, EHRosterShift, EHRosterShiftOptions, EHAttendanceStatus, EHKiosk, EHKioskEmployee, EHKioskStaffOptions, } from './types.js';
-export { AU_EMPLOYEE_FIELDS, LEAVE_REQUEST_FIELDS, LOCATION_FIELDS, EMPLOYEE_GROUP_FIELDS, ROSTER_SHIFT_FIELDS, KIOSK_FIELDS, KIOSK_EMPLOYEE_FIELDS, } from './types.js';
+export type { EHConfig, EHCacheConfig, EHRetryConfig, EHLeaveRequest, EHLeaveRequestOptions, EHEmployeeLeaveRequestOptions, EHLeaveRequestStatus, EHEmployee, EHEmployeeOptions, EHStandardHours, EHLocation, EHEmployeeGroup, EHRosterShift, EHRosterShiftOptions, EHAttendanceStatus, EHKiosk, EHKioskEmployee, EHKioskStaffOptions, } from './types.js';
+export { AU_EMPLOYEE_FIELDS, LEAVE_REQUEST_FIELDS, LOCATION_FIELDS, EMPLOYEE_GROUP_FIELDS, ROSTER_SHIFT_FIELDS, KIOSK_FIELDS, KIOSK_EMPLOYEE_FIELDS, ENTITIES, } from './types.js';
 export type { AccessTier } from './types.js';
 export { METHOD_TIERS } from './types.js';
 export type { EHAuEmployee } from './employee-types.generated.js';

package/dist/index.js

@@ -21,8 +21,8 @@
  */
 // Main client
 export { EHClient } from './client.js';
-// Field key constants (whitelists for pickFields)
-export { AU_EMPLOYEE_FIELDS, LEAVE_REQUEST_FIELDS, LOCATION_FIELDS, EMPLOYEE_GROUP_FIELDS, ROSTER_SHIFT_FIELDS, KIOSK_FIELDS, KIOSK_EMPLOYEE_FIELDS, } from './types.js';
+// Field definitions (for pickFields)
+export { AU_EMPLOYEE_FIELDS, LEAVE_REQUEST_FIELDS, LOCATION_FIELDS, EMPLOYEE_GROUP_FIELDS, ROSTER_SHIFT_FIELDS, KIOSK_FIELDS, KIOSK_EMPLOYEE_FIELDS, ENTITIES, } from './types.js';
 export { METHOD_TIERS } from './types.js';
 // Utilities
 export { buildBasicAuthHeader } from './utils.js';

package/dist/types.d.ts

@@ -178,7 +178,7 @@ export interface EHKioskEmployee {
  * Leave request from the Payroll API
  *
  * From GET /business/{id}/leaverequest
- * Field whitelist from Swagger HourLeaveRequestResponseModel.
+ * Fields from Swagger HourLeaveRequestResponseModel.
  */
 export interface EHLeaveRequest {
     /** Leave request ID */
@@ -225,6 +225,19 @@ export interface EHLeaveRequestOptions {
     /** Filter by location ID (→ API LocationId) */
     locationId?: number;
 }
+/**
+ * Options for getEmployeeLeaveRequests
+ *
+ * Filters are passed as OData $filter to the per-employee endpoint.
+ */
+export interface EHEmployeeLeaveRequestOptions {
+    /** Filter by status */
+    status?: EHLeaveRequestStatus;
+    /** Filter by start date (ISO 8601 date-time) */
+    fromDate?: string;
+    /** Filter by end date (ISO 8601 date-time) */
+    toDate?: string;
+}
 /**
  * Options for getEmployees
  */
@@ -309,20 +322,231 @@ export interface EHKioskStaffOptions {
     /** Restrict current shifts to current kiosk location (default: false) */
     restrictCurrentShiftsToCurrentKioskLocation?: boolean;
 }
-/** Whitelisted fields for EHLeaveRequest */
-export declare const LEAVE_REQUEST_FIELDS: readonly ["id", "employeeId", "leaveCategoryId", "employee", "leaveCategory", "fromDate", "toDate", "totalHours", "hoursApplied", "notes", "status"];
-/** Whitelisted fields for EHLocation */
-export declare const LOCATION_FIELDS: readonly ["id", "parentId", "name", "externalId", "source", "fullyQualifiedName", "isGlobal", "state", "country"];
-/** Whitelisted fields for EHKiosk */
-export declare const KIOSK_FIELDS: readonly ["id", "externalId", "name", "locationId", "timeZone", "ianaTimeZone", "allowHigherClassificationSelection", "isLocationRequired", "isWorkTypeRequired", "restrictLocationsForEmployees", "allowEmployeeShiftSelection", "clockOnWindowMinutes", "clockOffWindowMinutes", "isPhotoRequired", "canAddEmployees", "paidBreaksEnabled"];
-/** Whitelisted fields for EHKioskEmployee */
-export declare const KIOSK_EMPLOYEE_FIELDS: readonly ["employeeId", "firstName", "surname", "name", "status", "clockOnTimeUtc", "breakStartTimeUtc", "currentShiftId", "employeeStartDate", "employeeGroupIds", "longShift", "recordedTimeUtc"];
-/** Whitelisted fields for EHEmployeeGroup */
-export declare const EMPLOYEE_GROUP_FIELDS: readonly ["id", "name"];
-/** Whitelisted fields for EHRosterShift */
-export declare const ROSTER_SHIFT_FIELDS: readonly ["id", "employeeId", "employeeName", "locationId", "locationName", "workTypeId", "workTypeName", "startTime", "endTime", "notes", "published", "accepted"];
-/** Whitelisted fields for EHAuEmployee (139 fields) */
-export declare const AU_EMPLOYEE_FIELDS: readonly ["id", "externalId", "firstName", "surname", "status", "startDate", "endDate", "anniversaryDate", "dateCreated", "employmentType", "jobTitle", "employmentAgreement", "employmentAgreementId", "paySchedule", "payRateTemplate", "rate", "rateUnit", "hoursPerWeek", "hoursPerDay", "primaryPayCategory", "payConditionRuleSet", "overrideTemplateRate", "automaticallyPayEmployee", "primaryLocation", "locations", "tags", "workTypes", "reportingDimensionValues", "leaveAccrualStartDateType", "leaveTemplate", "leaveYearStart", "isEnabledForTimesheets", "rosteringNotificationChoices", "paySlipNotificationType", "terminationReason", "australianResident", "awardId", "businessAwardPackage", "automaticallyApplyPublicHolidayNotWorkedEarningsLines", "closelyHeldEmployee", "closelyHeldReporting", "disableAutoProgression", "dvlPaySlipDescription", "employingEntityId", "includeInPortableLongServiceLeaveReport", "portableLongServiceLeaveId", "isExemptFromFloodLevy", "isExemptFromPayrollTax", "isSeasonalWorker", "maximumQuarterlySuperContributionsBase", "superThresholdAmount", "singleTouchPayroll", "dateOfBirth", "gender", "title", "middleName", "preferredName", "previousSurname", "emailAddress", "homePhone", "mobilePhone", "workPhone", "bankAccount1_AccountName", "bankAccount1_AccountNumber", "bankAccount1_AllocatedPercentage", "bankAccount1_BSB", "bankAccount1_FixedAmount", "bankAccount2_AccountName", "bankAccount2_AccountNumber", "bankAccount2_AllocatedPercentage", "bankAccount2_BSB", "bankAccount2_FixedAmount", "bankAccount3_AccountName", "bankAccount3_AccountNumber", "bankAccount3_AllocatedPercentage", "bankAccount3_BSB", "bankAccount3_FixedAmount", "emergencyContact1_Address", "emergencyContact1_AlternateContactNumber", "emergencyContact1_ContactNumber", "emergencyContact1_Name", "emergencyContact1_Relationship", "emergencyContact2_Address", "emergencyContact2_AlternateContactNumber", "emergencyContact2_ContactNumber", "emergencyContact2_Name", "emergencyContact2_Relationship", "postalStreetAddress", "postalAddressLine2", "postalPostCode", "postalCountry", "postalState", "postalSuburb", "postalAddressIsOverseas", "residentialStreetAddress", "residentialAddressLine2", "residentialPostCode", "residentialCountry", "residentialState", "residentialSuburb", "residentialAddressIsOverseas", "taxFileNumber", "taxCategory", "taxVariation", "claimTaxFreeThreshold", "claimMedicareLevyReduction", "medicareLevyExemption", "medicareLevyReductionDependentCount", "medicareLevyReductionSpouse", "medicareLevySurchargeWithholdingTier", "seniorsTaxOffset", "otherTaxOffset", "stslDebt", "hasWithholdingVariation", "dateTaxFileDeclarationReported", "dateTaxFileDeclarationSigned", "superFund1_AllocatedPercentage", "superFund1_EmployerNominatedFund", "superFund1_FixedAmount", "superFund1_FundName", "superFund1_MemberNumber", "superFund1_ProductCode", "superFund2_AllocatedPercentage", "superFund2_EmployerNominatedFund", "superFund2_FixedAmount", "superFund2_FundName", "superFund2_MemberNumber", "superFund2_ProductCode", "superFund3_AllocatedPercentage", "superFund3_EmployerNominatedFund", "superFund3_FixedAmount", "superFund3_FundName", "superFund3_MemberNumber", "superFund3_ProductCode", "contractorABN", "employingEntityABN", "hasApprovedWorkingHolidayVisa", "workingHolidayVisaCountry", "workingHolidayVisaStartDate"];
+/** Fields for EHLeaveRequest — set false to exclude from API responses */
+export declare const LEAVE_REQUEST_FIELDS: {
+    readonly id: true;
+    readonly employeeId: true;
+    readonly leaveCategoryId: true;
+    readonly employee: true;
+    readonly leaveCategory: true;
+    readonly fromDate: true;
+    readonly toDate: true;
+    readonly totalHours: true;
+    readonly hoursApplied: true;
+    readonly notes: true;
+    readonly status: true;
+};
+/** Fields for EHLocation — set false to exclude from API responses */
+export declare const LOCATION_FIELDS: {
+    readonly id: true;
+    readonly parentId: true;
+    readonly name: true;
+    readonly externalId: true;
+    readonly source: true;
+    readonly fullyQualifiedName: true;
+    readonly isGlobal: true;
+    readonly state: true;
+    readonly country: true;
+};
+/** Fields for EHKiosk — set false to exclude from API responses */
+export declare const KIOSK_FIELDS: {
+    readonly id: true;
+    readonly externalId: true;
+    readonly name: true;
+    readonly locationId: true;
+    readonly timeZone: true;
+    readonly ianaTimeZone: true;
+    readonly allowHigherClassificationSelection: true;
+    readonly isLocationRequired: true;
+    readonly isWorkTypeRequired: true;
+    readonly restrictLocationsForEmployees: true;
+    readonly allowEmployeeShiftSelection: true;
+    readonly clockOnWindowMinutes: true;
+    readonly clockOffWindowMinutes: true;
+    readonly isPhotoRequired: true;
+    readonly canAddEmployees: true;
+    readonly paidBreaksEnabled: true;
+};
+/** Fields for EHKioskEmployee — set false to exclude from API responses */
+export declare const KIOSK_EMPLOYEE_FIELDS: {
+    readonly employeeId: true;
+    readonly firstName: true;
+    readonly surname: true;
+    readonly name: true;
+    readonly status: true;
+    readonly clockOnTimeUtc: true;
+    readonly breakStartTimeUtc: true;
+    readonly currentShiftId: true;
+    readonly employeeStartDate: true;
+    readonly employeeGroupIds: true;
+    readonly longShift: true;
+    readonly recordedTimeUtc: true;
+};
+/** Fields for EHEmployeeGroup — set false to exclude from API responses */
+export declare const EMPLOYEE_GROUP_FIELDS: {
+    readonly id: true;
+    readonly name: true;
+};
+/** Fields for EHRosterShift — set false to exclude from API responses */
+export declare const ROSTER_SHIFT_FIELDS: {
+    readonly id: true;
+    readonly employeeId: true;
+    readonly employeeName: true;
+    readonly locationId: true;
+    readonly locationName: true;
+    readonly workTypeId: true;
+    readonly workTypeName: true;
+    readonly startTime: true;
+    readonly endTime: true;
+    readonly notes: true;
+    readonly published: true;
+    readonly accepted: true;
+};
+/** Fields for EHAuEmployee — set false to exclude from API responses */
+export declare const AU_EMPLOYEE_FIELDS: {
+    readonly id: true;
+    readonly externalId: true;
+    readonly firstName: true;
+    readonly surname: true;
+    readonly status: true;
+    readonly startDate: true;
+    readonly endDate: true;
+    readonly anniversaryDate: false;
+    readonly dateCreated: false;
+    readonly employmentType: true;
+    readonly jobTitle: true;
+    readonly employmentAgreement: false;
+    readonly employmentAgreementId: false;
+    readonly paySchedule: false;
+    readonly payRateTemplate: false;
+    readonly rate: false;
+    readonly rateUnit: false;
+    readonly hoursPerWeek: false;
+    readonly hoursPerDay: false;
+    readonly primaryPayCategory: false;
+    readonly payConditionRuleSet: false;
+    readonly overrideTemplateRate: false;
+    readonly automaticallyPayEmployee: false;
+    readonly primaryLocation: true;
+    readonly locations: false;
+    readonly tags: false;
+    readonly workTypes: false;
+    readonly reportingDimensionValues: false;
+    readonly leaveAccrualStartDateType: false;
+    readonly leaveTemplate: false;
+    readonly leaveYearStart: false;
+    readonly isEnabledForTimesheets: false;
+    readonly rosteringNotificationChoices: false;
+    readonly paySlipNotificationType: false;
+    readonly terminationReason: false;
+    readonly australianResident: false;
+    readonly awardId: false;
+    readonly businessAwardPackage: false;
+    readonly automaticallyApplyPublicHolidayNotWorkedEarningsLines: false;
+    readonly closelyHeldEmployee: false;
+    readonly closelyHeldReporting: false;
+    readonly disableAutoProgression: false;
+    readonly dvlPaySlipDescription: false;
+    readonly employingEntityId: false;
+    readonly includeInPortableLongServiceLeaveReport: false;
+    readonly portableLongServiceLeaveId: false;
+    readonly isExemptFromFloodLevy: false;
+    readonly isExemptFromPayrollTax: false;
+    readonly isSeasonalWorker: false;
+    readonly maximumQuarterlySuperContributionsBase: false;
+    readonly superThresholdAmount: false;
+    readonly singleTouchPayroll: false;
+    readonly dateOfBirth: false;
+    readonly gender: false;
+    readonly title: false;
+    readonly middleName: false;
+    readonly preferredName: false;
+    readonly previousSurname: false;
+    readonly emailAddress: true;
+    readonly homePhone: false;
+    readonly mobilePhone: false;
+    readonly workPhone: false;
+    readonly bankAccount1_AccountName: false;
+    readonly bankAccount1_AccountNumber: false;
+    readonly bankAccount1_AllocatedPercentage: false;
+    readonly bankAccount1_BSB: false;
+    readonly bankAccount1_FixedAmount: false;
+    readonly bankAccount2_AccountName: false;
+    readonly bankAccount2_AccountNumber: false;
+    readonly bankAccount2_AllocatedPercentage: false;
+    readonly bankAccount2_BSB: false;
+    readonly bankAccount2_FixedAmount: false;
+    readonly bankAccount3_AccountName: false;
+    readonly bankAccount3_AccountNumber: false;
+    readonly bankAccount3_AllocatedPercentage: false;
+    readonly bankAccount3_BSB: false;
+    readonly bankAccount3_FixedAmount: false;
+    readonly emergencyContact1_Address: false;
+    readonly emergencyContact1_AlternateContactNumber: false;
+    readonly emergencyContact1_ContactNumber: false;
+    readonly emergencyContact1_Name: false;
+    readonly emergencyContact1_Relationship: false;
+    readonly emergencyContact2_Address: false;
+    readonly emergencyContact2_AlternateContactNumber: false;
+    readonly emergencyContact2_ContactNumber: false;
+    readonly emergencyContact2_Name: false;
+    readonly emergencyContact2_Relationship: false;
+    readonly postalStreetAddress: false;
+    readonly postalAddressLine2: false;
+    readonly postalPostCode: false;
+    readonly postalCountry: false;
+    readonly postalState: false;
+    readonly postalSuburb: false;
+    readonly postalAddressIsOverseas: false;
+    readonly residentialStreetAddress: false;
+    readonly residentialAddressLine2: false;
+    readonly residentialPostCode: false;
+    readonly residentialCountry: false;
+    readonly residentialState: false;
+    readonly residentialSuburb: false;
+    readonly residentialAddressIsOverseas: false;
+    readonly taxFileNumber: false;
+    readonly taxCategory: false;
+    readonly taxVariation: false;
+    readonly claimTaxFreeThreshold: false;
+    readonly claimMedicareLevyReduction: false;
+    readonly medicareLevyExemption: false;
+    readonly medicareLevyReductionDependentCount: false;
+    readonly medicareLevyReductionSpouse: false;
+    readonly medicareLevySurchargeWithholdingTier: false;
+    readonly seniorsTaxOffset: false;
+    readonly otherTaxOffset: false;
+    readonly stslDebt: false;
+    readonly hasWithholdingVariation: false;
+    readonly dateTaxFileDeclarationReported: false;
+    readonly dateTaxFileDeclarationSigned: false;
+    readonly superFund1_AllocatedPercentage: false;
+    readonly superFund1_EmployerNominatedFund: false;
+    readonly superFund1_FixedAmount: false;
+    readonly superFund1_FundName: false;
+    readonly superFund1_MemberNumber: false;
+    readonly superFund1_ProductCode: false;
+    readonly superFund2_AllocatedPercentage: false;
+    readonly superFund2_EmployerNominatedFund: false;
+    readonly superFund2_FixedAmount: false;
+    readonly superFund2_FundName: false;
+    readonly superFund2_MemberNumber: false;
+    readonly superFund2_ProductCode: false;
+    readonly superFund3_AllocatedPercentage: false;
+    readonly superFund3_EmployerNominatedFund: false;
+    readonly superFund3_FixedAmount: false;
+    readonly superFund3_FundName: false;
+    readonly superFund3_MemberNumber: false;
+    readonly superFund3_ProductCode: false;
+    readonly contractorABN: false;
+    readonly employingEntityABN: false;
+    readonly hasApprovedWorkingHolidayVisa: false;
+    readonly workingHolidayVisaCountry: false;
+    readonly workingHolidayVisaStartDate: false;
+};
+import type { EntityDef } from '@markwharton/api-core';
+/** Entity registry — maps interface names to field specs and API path segments. */
+export declare const ENTITIES: Record<string, EntityDef>;
 /** Access tier for method-level authorization */
 export type AccessTier = 'standard' | 'restricted';
 /**

package/dist/types.js

@@ -5,110 +5,121 @@
  * Based on the API reference and KeyPay .NET SDK models.
  */
 // ============================================================================
-// Field Key Constants (whitelists for pickFields)
+// Field Definitions (for pickFields)
 // ============================================================================
-/** Whitelisted fields for EHLeaveRequest */
-export const LEAVE_REQUEST_FIELDS = [
-    'id', 'employeeId', 'leaveCategoryId', 'employee', 'leaveCategory',
-    'fromDate', 'toDate', 'totalHours', 'hoursApplied', 'notes', 'status',
-];
-/** Whitelisted fields for EHLocation */
-export const LOCATION_FIELDS = [
-    'id', 'parentId', 'name', 'externalId', 'source',
-    'fullyQualifiedName', 'isGlobal', 'state', 'country',
-];
-/** Whitelisted fields for EHKiosk */
-export const KIOSK_FIELDS = [
-    'id', 'externalId', 'name', 'locationId', 'timeZone', 'ianaTimeZone',
-    'allowHigherClassificationSelection', 'isLocationRequired', 'isWorkTypeRequired',
-    'restrictLocationsForEmployees', 'allowEmployeeShiftSelection',
-    'clockOnWindowMinutes', 'clockOffWindowMinutes',
-    'isPhotoRequired', 'canAddEmployees', 'paidBreaksEnabled',
-];
-/** Whitelisted fields for EHKioskEmployee */
-export const KIOSK_EMPLOYEE_FIELDS = [
-    'employeeId', 'firstName', 'surname', 'name', 'status',
-    'clockOnTimeUtc', 'breakStartTimeUtc', 'currentShiftId',
-    'employeeStartDate', 'employeeGroupIds', 'longShift', 'recordedTimeUtc',
-];
-/** Whitelisted fields for EHEmployeeGroup */
-export const EMPLOYEE_GROUP_FIELDS = [
-    'id', 'name',
-];
-/** Whitelisted fields for EHRosterShift */
-export const ROSTER_SHIFT_FIELDS = [
-    'id', 'employeeId', 'employeeName', 'locationId', 'locationName',
-    'workTypeId', 'workTypeName', 'startTime', 'endTime',
-    'notes', 'published', 'accepted',
-];
-/** Whitelisted fields for EHAuEmployee (139 fields) */
-export const AU_EMPLOYEE_FIELDS = [
+/** Fields for EHLeaveRequest — set false to exclude from API responses */
+export const 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 EHLocation — set false to exclude from API responses */
+export const LOCATION_FIELDS = {
+    id: true, parentId: true, name: true, externalId: true, source: true,
+    fullyQualifiedName: true, isGlobal: true, state: true, country: true,
+};
+/** Fields for EHKiosk — set false to exclude from API responses */
+export const KIOSK_FIELDS = {
+    id: true, externalId: true, name: true, locationId: true, timeZone: true, ianaTimeZone: true,
+    allowHigherClassificationSelection: true, isLocationRequired: true, isWorkTypeRequired: true,
+    restrictLocationsForEmployees: true, allowEmployeeShiftSelection: true,
+    clockOnWindowMinutes: true, clockOffWindowMinutes: true,
+    isPhotoRequired: true, canAddEmployees: true, paidBreaksEnabled: true,
+};
+/** Fields for EHKioskEmployee — set false to exclude from API responses */
+export const KIOSK_EMPLOYEE_FIELDS = {
+    employeeId: true, firstName: true, surname: true, name: true, status: true,
+    clockOnTimeUtc: true, breakStartTimeUtc: true, currentShiftId: true,
+    employeeStartDate: true, employeeGroupIds: true, longShift: true, recordedTimeUtc: true,
+};
+/** Fields for EHEmployeeGroup — set false to exclude from API responses */
+export const EMPLOYEE_GROUP_FIELDS = {
+    id: true, name: true,
+};
+/** Fields for EHRosterShift — set false to exclude from API responses */
+export const ROSTER_SHIFT_FIELDS = {
+    id: true, employeeId: true, employeeName: true, locationId: true, locationName: true,
+    workTypeId: true, workTypeName: true, startTime: true, endTime: true,
+    notes: true, published: true, accepted: true,
+};
+/** Fields for EHAuEmployee — set false to exclude from API responses */
+export const AU_EMPLOYEE_FIELDS = {
     // Identity
-    'id', 'externalId', 'firstName', 'surname', 'status',
+    id: true, externalId: true, firstName: true, surname: true, status: true,
     // Dates
-    'startDate', 'endDate', 'anniversaryDate', 'dateCreated',
+    startDate: true, endDate: true, anniversaryDate: false, dateCreated: false,
     // Employment
-    'employmentType', 'jobTitle', 'employmentAgreement', 'employmentAgreementId',
+    employmentType: true, jobTitle: true, employmentAgreement: false, employmentAgreementId: false,
     // Pay
-    'paySchedule', 'payRateTemplate', 'rate', 'rateUnit', 'hoursPerWeek', 'hoursPerDay',
-    'primaryPayCategory', 'payConditionRuleSet', 'overrideTemplateRate', 'automaticallyPayEmployee',
+    paySchedule: false, payRateTemplate: false, rate: false, rateUnit: false, hoursPerWeek: false, hoursPerDay: false,
+    primaryPayCategory: false, payConditionRuleSet: false, overrideTemplateRate: false, automaticallyPayEmployee: false,
     // Location/org
-    'primaryLocation', 'locations', 'tags', 'workTypes', 'reportingDimensionValues',
+    primaryLocation: true, locations: false, tags: false, workTypes: false, reportingDimensionValues: false,
     // Leave
-    'leaveAccrualStartDateType', 'leaveTemplate', 'leaveYearStart',
+    leaveAccrualStartDateType: false, leaveTemplate: false, leaveYearStart: false,
     // Flags
-    'isEnabledForTimesheets', 'rosteringNotificationChoices', 'paySlipNotificationType', 'terminationReason',
+    isEnabledForTimesheets: false, rosteringNotificationChoices: false, paySlipNotificationType: false, terminationReason: false,
     // AU compliance
-    'australianResident', 'awardId', 'businessAwardPackage',
-    'automaticallyApplyPublicHolidayNotWorkedEarningsLines',
-    'closelyHeldEmployee', 'closelyHeldReporting',
-    'disableAutoProgression', 'dvlPaySlipDescription',
-    'employingEntityId',
-    'includeInPortableLongServiceLeaveReport', 'portableLongServiceLeaveId',
-    'isExemptFromFloodLevy', 'isExemptFromPayrollTax', 'isSeasonalWorker',
-    'maximumQuarterlySuperContributionsBase', 'superThresholdAmount',
-    'singleTouchPayroll',
+    australianResident: false, awardId: false, businessAwardPackage: false,
+    automaticallyApplyPublicHolidayNotWorkedEarningsLines: false,
+    closelyHeldEmployee: false, closelyHeldReporting: false,
+    disableAutoProgression: false, dvlPaySlipDescription: false,
+    employingEntityId: false,
+    includeInPortableLongServiceLeaveReport: false, portableLongServiceLeaveId: false,
+    isExemptFromFloodLevy: false, isExemptFromPayrollTax: false, isSeasonalWorker: false,
+    maximumQuarterlySuperContributionsBase: false, superThresholdAmount: false,
+    singleTouchPayroll: false,
     // Personal
-    'dateOfBirth', 'gender', 'title', 'middleName', 'preferredName', 'previousSurname',
+    dateOfBirth: false, gender: false, title: false, middleName: false, preferredName: false, previousSurname: false,
     // Contact
-    'emailAddress', 'homePhone', 'mobilePhone', 'workPhone',
+    emailAddress: true, homePhone: false, mobilePhone: false, workPhone: false,
     // Bank accounts
-    'bankAccount1_AccountName', 'bankAccount1_AccountNumber',
-    'bankAccount1_AllocatedPercentage', 'bankAccount1_BSB', 'bankAccount1_FixedAmount',
-    'bankAccount2_AccountName', 'bankAccount2_AccountNumber',
-    'bankAccount2_AllocatedPercentage', 'bankAccount2_BSB', 'bankAccount2_FixedAmount',
-    'bankAccount3_AccountName', 'bankAccount3_AccountNumber',
-    'bankAccount3_AllocatedPercentage', 'bankAccount3_BSB', 'bankAccount3_FixedAmount',
+    bankAccount1_AccountName: false, bankAccount1_AccountNumber: false,
+    bankAccount1_AllocatedPercentage: false, bankAccount1_BSB: false, bankAccount1_FixedAmount: false,
+    bankAccount2_AccountName: false, bankAccount2_AccountNumber: false,
+    bankAccount2_AllocatedPercentage: false, bankAccount2_BSB: false, bankAccount2_FixedAmount: false,
+    bankAccount3_AccountName: false, bankAccount3_AccountNumber: false,
+    bankAccount3_AllocatedPercentage: false, bankAccount3_BSB: false, bankAccount3_FixedAmount: false,
     // Emergency contacts
-    'emergencyContact1_Address', 'emergencyContact1_AlternateContactNumber',
-    'emergencyContact1_ContactNumber', 'emergencyContact1_Name', 'emergencyContact1_Relationship',
-    'emergencyContact2_Address', 'emergencyContact2_AlternateContactNumber',
-    'emergencyContact2_ContactNumber', 'emergencyContact2_Name', 'emergencyContact2_Relationship',
+    emergencyContact1_Address: false, emergencyContact1_AlternateContactNumber: false,
+    emergencyContact1_ContactNumber: false, emergencyContact1_Name: false, emergencyContact1_Relationship: false,
+    emergencyContact2_Address: false, emergencyContact2_AlternateContactNumber: false,
+    emergencyContact2_ContactNumber: false, emergencyContact2_Name: false, emergencyContact2_Relationship: false,
     // Postal address
-    'postalStreetAddress', 'postalAddressLine2', 'postalPostCode', 'postalCountry',
-    'postalState', 'postalSuburb', 'postalAddressIsOverseas',
+    postalStreetAddress: false, postalAddressLine2: false, postalPostCode: false, postalCountry: false,
+    postalState: false, postalSuburb: false, postalAddressIsOverseas: false,
     // Residential address
-    'residentialStreetAddress', 'residentialAddressLine2', 'residentialPostCode', 'residentialCountry',
-    'residentialState', 'residentialSuburb', 'residentialAddressIsOverseas',
+    residentialStreetAddress: false, residentialAddressLine2: false, residentialPostCode: false, residentialCountry: false,
+    residentialState: false, residentialSuburb: false, residentialAddressIsOverseas: false,
     // Tax
-    'taxFileNumber', 'taxCategory', 'taxVariation',
-    'claimTaxFreeThreshold', 'claimMedicareLevyReduction',
-    'medicareLevyExemption', 'medicareLevyReductionDependentCount',
-    'medicareLevyReductionSpouse', 'medicareLevySurchargeWithholdingTier',
-    'seniorsTaxOffset', 'otherTaxOffset', 'stslDebt',
-    'hasWithholdingVariation', 'dateTaxFileDeclarationReported', 'dateTaxFileDeclarationSigned',
+    taxFileNumber: false, taxCategory: false, taxVariation: false,
+    claimTaxFreeThreshold: false, claimMedicareLevyReduction: false,
+    medicareLevyExemption: false, medicareLevyReductionDependentCount: false,
+    medicareLevyReductionSpouse: false, medicareLevySurchargeWithholdingTier: false,
+    seniorsTaxOffset: false, otherTaxOffset: false, stslDebt: false,
+    hasWithholdingVariation: false, dateTaxFileDeclarationReported: false, dateTaxFileDeclarationSigned: false,
     // Super funds
-    'superFund1_AllocatedPercentage', 'superFund1_EmployerNominatedFund',
-    'superFund1_FixedAmount', 'superFund1_FundName', 'superFund1_MemberNumber', 'superFund1_ProductCode',
-    'superFund2_AllocatedPercentage', 'superFund2_EmployerNominatedFund',
-    'superFund2_FixedAmount', 'superFund2_FundName', 'superFund2_MemberNumber', 'superFund2_ProductCode',
-    'superFund3_AllocatedPercentage', 'superFund3_EmployerNominatedFund',
-    'superFund3_FixedAmount', 'superFund3_FundName', 'superFund3_MemberNumber', 'superFund3_ProductCode',
+    superFund1_AllocatedPercentage: false, superFund1_EmployerNominatedFund: false,
+    superFund1_FixedAmount: false, superFund1_FundName: false, superFund1_MemberNumber: false, superFund1_ProductCode: false,
+    superFund2_AllocatedPercentage: false, superFund2_EmployerNominatedFund: false,
+    superFund2_FixedAmount: false, superFund2_FundName: false, superFund2_MemberNumber: false, superFund2_ProductCode: false,
+    superFund3_AllocatedPercentage: false, superFund3_EmployerNominatedFund: false,
+    superFund3_FixedAmount: false, superFund3_FundName: false, superFund3_MemberNumber: false, superFund3_ProductCode: false,
     // ABNs
-    'contractorABN', 'employingEntityABN',
+    contractorABN: false, employingEntityABN: false,
     // Visa
-    'hasApprovedWorkingHolidayVisa', 'workingHolidayVisaCountry', 'workingHolidayVisaStartDate',
-];
+    hasApprovedWorkingHolidayVisa: false, workingHolidayVisaCountry: false, workingHolidayVisaStartDate: false,
+};
+/** Entity registry — maps interface names to field specs and API path segments. */
+export const ENTITIES = {
+    EHAuEmployee: { fields: AU_EMPLOYEE_FIELDS, path: 'employee/unstructured', apiRef: 'employee/au-employee--get-employees' },
+    EHLeaveRequest: { fields: LEAVE_REQUEST_FIELDS, path: 'leaverequest', apiRef: 'leaverequests/au-leave-request--get-leave-requests' },
+    EHEmployeeLeaveRequest: { fields: LEAVE_REQUEST_FIELDS, path: 'employee/{employeeId}/leaverequest', apiRef: 'leaverequests/au-leave-request--get-leave-requests-for-employee' },
+    EHLocation: { fields: LOCATION_FIELDS, path: 'location', apiRef: 'location/location--get-locations' },
+    EHRosterShift: { fields: ROSTER_SHIFT_FIELDS, path: 'rostershift', apiRef: 'rostershift/roster-shift--get-roster-shifts' },
+    EHKiosk: { fields: KIOSK_FIELDS, path: 'kiosk', apiRef: 'kiosk/kiosk--list-kiosks' },
+    EHKioskEmployee: { fields: KIOSK_EMPLOYEE_FIELDS, path: 'kiosk/{kioskId}/staff', apiRef: 'kiosk/kiosk--get-kiosk-staff' },
+    EHEmployeeGroup: { fields: EMPLOYEE_GROUP_FIELDS, path: 'employeegroup', apiRef: 'employeegroups/employee-group--get-employee-groups' },
+};
 /**
  * Access tier for each data method.
  *
@@ -124,6 +135,7 @@ export const METHOD_TIERS = {
     getRosterShifts: 'standard',
     getEmployees: 'restricted',
     getLeaveRequests: 'restricted',
+    getEmployeeLeaveRequests: 'restricted',
     getEmployee: 'restricted',
     getStandardHours: 'restricted',
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@markwharton/eh-payroll",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "Employment Hero Payroll API client",
   "type": "module",
   "main": "dist/index.js",
@@ -16,7 +16,7 @@
     "clean": "rm -rf dist"
   },
   "dependencies": {
-    "@markwharton/api-core": "^1.3.0"
+    "@markwharton/api-core": "^1.5.0"
   },
   "devDependencies": {
     "@types/node": "^20.10.0",