@markwharton/eh-payroll 3.1.0 → 3.2.1

package/README.md

@@ -11,9 +11,9 @@ npm install @markwharton/eh-payroll
 ## Quick Start
 
 ```typescript
-import { EHClient } from '@markwharton/eh-payroll';
+import { PayrollClient } from '@markwharton/eh-payroll';
 
-const client = new EHClient({
+const client = new PayrollClient({
   apiKey: 'xxx',
   businessId: 123,
   region: 'au',  // 'au' | 'nz' | 'uk' | 'sg' | 'my' (default: 'au')
@@ -25,15 +25,15 @@ if (!validation.ok) throw new Error(validation.error);
 
 // Get all employees
 const empResult = await client.getEmployees();
-if (empResult.ok) console.log(empResult.data); // EHAuEmployee[]
+if (empResult.ok) console.log(empResult.data); // PayrollAuEmployee[]
 
 // Get employees filtered by location
 const filteredResult = await client.getEmployees({ locationId: 5 });
-if (filteredResult.ok) console.log(filteredResult.data); // EHAuEmployee[]
+if (filteredResult.ok) console.log(filteredResult.data); // PayrollAuEmployee[]
 
 // Get roster shifts for a date range (auto-paginates)
 const rosterResult = await client.getRosterShifts('2026-02-03', '2026-02-09');
-if (rosterResult.ok) console.log(rosterResult.data); // EHRosterShift[]
+if (rosterResult.ok) console.log(rosterResult.data); // PayrollRosterShift[]
 
 // Get roster shifts with filters
 const pubResult = await client.getRosterShifts('2026-02-03', '2026-02-09', {
@@ -41,7 +41,7 @@ const pubResult = await client.getRosterShifts('2026-02-03', '2026-02-09', {
   shiftStatus: 'Published',
   selectAllRoles: true
 });
-if (pubResult.ok) console.log(pubResult.data); // EHRosterShift[]
+if (pubResult.ok) console.log(pubResult.data); // PayrollRosterShift[]
 
 // Get leave requests for a date range (all filters server-side)
 const leaveResult = await client.getLeaveRequests({
@@ -49,27 +49,27 @@ const leaveResult = await client.getLeaveRequests({
   toDate: '2026-03-31',
   status: 'Approved',
 });
-if (leaveResult.ok) console.log(leaveResult.data); // EHLeaveRequest[]
+if (leaveResult.ok) console.log(leaveResult.data); // PayrollLeaveRequest[]
 
 // Get business locations
 const locResult = await client.getLocations();
-if (locResult.ok) console.log(locResult.data); // EHLocation[]
+if (locResult.ok) console.log(locResult.data); // PayrollLocation[]
 
 // List kiosks
 const kioskResult = await client.getKiosks();
-if (kioskResult.ok) console.log(kioskResult.data); // EHKiosk[]
+if (kioskResult.ok) console.log(kioskResult.data); // PayrollKiosk[]
 
 // Get kiosk staff (time and attendance)
 const staffResult = await client.getKioskStaff(kioskId);
-if (staffResult.ok) console.log(staffResult.data); // EHKioskEmployee[]
+if (staffResult.ok) console.log(staffResult.data); // PayrollKioskEmployee[]
 
 // Get employee groups
 const groupResult = await client.getEmployeeGroups();
-if (groupResult.ok) console.log(groupResult.data); // EHEmployeeGroup[]
+if (groupResult.ok) console.log(groupResult.data); // PayrollEmployeeGroup[]
 
 // Get standard hours for an employee (includes FTE value)
 const hoursResult = await client.getStandardHours(employeeId);
-if (hoursResult.ok) console.log(hoursResult.data); // EHStandardHours
+if (hoursResult.ok) console.log(hoursResult.data); // PayrollStandardHours
 
 ```
 
@@ -82,17 +82,17 @@ All methods return `Result<T>` — see [api-core Result Pattern](../../README.md
 | Method | Parameters | Returns |
 |--------|-----------|---------|
 | `validateApiKey()` | — | `Result<void>` |
-| `getEmployees(options?)` | `EHEmployeeOptions?` | `Result<EHAuEmployee[]>` |
-| `getEmployee(employeeId)` | `number` | `Result<EHAuEmployee>` |
-| `getEmployeeImage(employeeId)` | `number` | `Result<EHEmployeeImage>` |
-| `getStandardHours(employeeId)` | `number` | `Result<EHStandardHours>` |
-| `getLocations()` | — | `Result<EHLocation[]>` |
-| `getEmployeeGroups()` | — | `Result<EHEmployeeGroup[]>` |
-| `getRosterShifts(from, to, options?)` | `string, string, EHRosterShiftOptions?` | `Result<EHRosterShift[]>` |
-| `getKiosks()` | — | `Result<EHKiosk[]>` |
-| `getKioskStaff(kioskId, options?)` | `number, EHKioskStaffOptions?` | `Result<EHKioskEmployee[]>` |
-| `getLeaveRequests(options?)` | `EHLeaveRequestOptions?` | `Result<EHLeaveRequest[]>` |
-| `getEmployeeLeaveRequests(employeeId, options?)` | `number, EHEmployeeLeaveRequestOptions?` | `Result<EHLeaveRequest[]>` |
+| `getEmployees(options?)` | `PayrollEmployeeOptions?` | `Result<PayrollAuEmployee[]>` |
+| `getEmployee(employeeId)` | `number` | `Result<PayrollAuEmployee>` |
+| `getEmployeeImage(employeeId)` | `number` | `Result<PayrollEmployeeImage>` |
+| `getStandardHours(employeeId)` | `number` | `Result<PayrollStandardHours>` |
+| `getLocations()` | — | `Result<PayrollLocation[]>` |
+| `getEmployeeGroups()` | — | `Result<PayrollEmployeeGroup[]>` |
+| `getRosterShifts(from, to, options?)` | `string, string, PayrollRosterShiftOptions?` | `Result<PayrollRosterShift[]>` |
+| `getKiosks()` | — | `Result<PayrollKiosk[]>` |
+| `getKioskStaff(kioskId, options?)` | `number, PayrollKioskStaffOptions?` | `Result<PayrollKioskEmployee[]>` |
+| `getLeaveRequests(options?)` | `PayrollLeaveRequestOptions?` | `Result<PayrollLeaveRequest[]>` |
+| `getEmployeeLeaveRequests(employeeId, options?)` | `number, PayrollEmployeeLeaveRequestOptions?` | `Result<PayrollLeaveRequest[]>` |
 | `clearCache()` | — | `void` |
 | `invalidateEmployeeCache()` | — | `void` |
 | `invalidateLeaveRequestCache()` | — | `void` |
@@ -106,13 +106,13 @@ Returns leave requests with all filters applied server-side. The business-level
 
 **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`:**
+**`PayrollLeaveRequestOptions`:**
 
 | Option | Type | Description |
 |--------|------|-------------|
 | `fromDate` | `string` | Start date filter (YYYY-MM-DD) |
 | `toDate` | `string` | End date filter (YYYY-MM-DD) |
-| `status` | `EHLeaveRequestStatus` | `'Approved'`, `'Pending'`, `'Rejected'`, or `'Cancelled'` |
+| `status` | `PayrollLeaveRequestStatus` | `'Approved'`, `'Pending'`, `'Rejected'`, or `'Cancelled'` |
 | `employeeId` | `number` | Filter by employee ID |
 | `leaveCategoryId` | `number` | Filter by leave category ID |
 | `locationId` | `number` | Filter by location ID |
@@ -123,11 +123,11 @@ Returns leave requests with all filters applied server-side. The business-level
 
 Returns leave requests for a specific employee using the per-employee endpoint with OData pagination.
 
-**`EHEmployeeLeaveRequestOptions`:**
+**`PayrollEmployeeLeaveRequestOptions`:**
 
 | Option | Type | Description |
 |--------|------|-------------|
-| `status` | `EHLeaveRequestStatus` | `'Approved'`, `'Pending'`, `'Rejected'`, or `'Cancelled'` |
+| `status` | `PayrollLeaveRequestStatus` | `'Approved'`, `'Pending'`, `'Rejected'`, or `'Cancelled'` |
 | `fromDate` | `string` | Start date filter (ISO 8601) |
 | `toDate` | `string` | End date filter (ISO 8601) |
 
@@ -142,7 +142,7 @@ The [KeyPay Swagger spec](https://api.keypay.com.au/swagger-au.json) uses incons
 ## Configuration
 
 ```typescript
-const client = new EHClient({
+const client = new PayrollClient({
   apiKey: 'your-api-key',       // Required: used as Basic Auth username
   businessId: 12345,            // Required: business ID
   region: 'au',                 // Optional: au, nz, uk, sg, my (default: au)
@@ -159,7 +159,7 @@ const client = new EHClient({
 });
 ```
 
-`EHConfig` extends `ClientConfig` from api-core, which provides the `baseUrl`, `onRequest`, `retry`, and `cacheInstance` fields. `apiKey`, `businessId`, `region`, `cache`, and `rateLimitPerSecond` are EH-specific. Pass `cacheInstance` to use a custom cache backend (e.g., `LayeredCache` with persistent stores); otherwise `cache: {}` creates an in-memory `TTLCache`. Set `persistRestricted: false` to keep restricted-tier data in memory only.
+`PayrollConfig` extends `ClientConfig` from api-core, which provides the `baseUrl`, `onRequest`, `retry`, and `cacheInstance` fields. `apiKey`, `businessId`, `region`, `cache`, and `rateLimitPerSecond` are payroll-specific. Pass `cacheInstance` to use a custom cache backend (e.g., `LayeredCache` with persistent stores); otherwise `cache: {}` creates an in-memory `TTLCache`. Set `persistRestricted: false` to keep restricted-tier data in memory only.
 
 ### Cache TTLs
 

package/dist/client.d.ts

@@ -6,15 +6,15 @@
  *
  * @see https://api.keypay.com.au/
  */
-import type { EHConfig, EHLeaveRequest, EHLeaveRequestOptions, EHEmployeeLeaveRequestOptions, EHEmployeeOptions, EHStandardHours, EHLocation, EHEmployeeGroup, EHRosterShift, EHRosterShiftOptions, EHKiosk, EHKioskEmployee, EHKioskStaffOptions, EHEmployeeImage } from './types.js';
-import type { EHEmployee } from './employee-types.generated.js';
+import type { PayrollConfig, PayrollLeaveRequest, PayrollLeaveRequestOptions, PayrollEmployeeLeaveRequestOptions, PayrollEmployeeOptions, PayrollStandardHours, 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';
 /**
  * Employment Hero Payroll API Client
  *
  * @example
  * ```typescript
- * const client = new EHClient({ apiKey: 'xxx', businessId: 123 });
+ * const client = new PayrollClient({ apiKey: 'xxx', businessId: 123 });
  *
  * // Validate credentials
  * await client.validateApiKey();
@@ -23,7 +23,7 @@ import type { Result } from '@markwharton/api-core';
  * const { data: employees } = await client.getEmployees();
  * ```
  */
-export declare class EHClient {
+export declare class PayrollClient {
     private readonly apiKey;
     private readonly businessId;
     private readonly baseUrl;
@@ -33,7 +33,7 @@ export declare class EHClient {
     private readonly retryConfig?;
     private readonly rateLimiter?;
     private readonly persistRestricted;
-    constructor(config: EHConfig);
+    constructor(config: PayrollConfig);
     /** Cache options for restricted-tier methods: skip persistent stores when persistRestricted is false. */
     private get restrictedPersistOpt();
     /** Route through cache if enabled, skipping failed Results. */
@@ -101,22 +101,22 @@ export declare class EHClient {
      *
      * @see https://api.keypay.com.au/australia/reference/leave-requests/au-business-hours-leave-request--list-leave-requests.html
      */
-    getLeaveRequests(options?: EHLeaveRequestOptions): Promise<Result<EHLeaveRequest[]>>;
+    getLeaveRequests(options?: PayrollLeaveRequestOptions): Promise<Result<PayrollLeaveRequest[]>>;
     /**
      * 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[]>>;
+    getEmployeeLeaveRequests(employeeId: number, options?: PayrollEmployeeLeaveRequestOptions): Promise<Result<PayrollLeaveRequest[]>>;
     /**
      * Get all employees
      */
-    getEmployees(options?: EHEmployeeOptions): Promise<Result<EHEmployee[]>>;
+    getEmployees(options?: PayrollEmployeeOptions): Promise<Result<PayrollEmployee[]>>;
     /**
      * Get a single employee by ID
      */
-    getEmployee(employeeId: number): Promise<Result<EHEmployee>>;
+    getEmployee(employeeId: number): Promise<Result<PayrollEmployee>>;
     /**
      * Get employee profile image
      *
@@ -124,19 +124,19 @@ export declare class EHClient {
      *
      * @see https://api.keypay.com.au/australia/reference/employee/au-employee--get-employee-profile-image.html
      */
-    getEmployeeImage(employeeId: number): Promise<Result<EHEmployeeImage>>;
+    getEmployeeImage(employeeId: number): Promise<Result<PayrollEmployeeImage>>;
     /**
      * Get standard hours for an employee (includes FTE value)
      */
-    getStandardHours(employeeId: number): Promise<Result<EHStandardHours>>;
+    getStandardHours(employeeId: number): Promise<Result<PayrollStandardHours>>;
     /**
      * Get all business locations
      */
-    getLocations(): Promise<Result<EHLocation[]>>;
+    getLocations(): Promise<Result<PayrollLocation[]>>;
     /**
      * Get all employee groups
      */
-    getEmployeeGroups(): Promise<Result<EHEmployeeGroup[]>>;
+    getEmployeeGroups(): Promise<Result<PayrollEmployeeGroup[]>>;
     /**
      * Get roster shifts for a date range
      *
@@ -144,16 +144,16 @@ export declare class EHClient {
      * @param toDate - End date (YYYY-MM-DD)
      * @param options - Optional filters
      */
-    getRosterShifts(fromDate: string, toDate: string, options?: EHRosterShiftOptions): Promise<Result<EHRosterShift[]>>;
+    getRosterShifts(fromDate: string, toDate: string, options?: PayrollRosterShiftOptions): Promise<Result<PayrollRosterShift[]>>;
     /**
      * Get all kiosks for the business
      */
-    getKiosks(): Promise<Result<EHKiosk[]>>;
+    getKiosks(): Promise<Result<PayrollKiosk[]>>;
     /**
      * Get kiosk staff for time and attendance
      *
      * @param kioskId - Kiosk identifier
      * @param options - Optional query parameters
      */
-    getKioskStaff(kioskId: number, options?: EHKioskStaffOptions): Promise<Result<EHKioskEmployee[]>>;
+    getKioskStaff(kioskId: number, options?: PayrollKioskStaffOptions): Promise<Result<PayrollKioskEmployee[]>>;
 }

package/dist/client.js

@@ -8,8 +8,8 @@
  */
 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 { parsePayrollErrorResponse } from './errors.js';
+import { PAYROLL_API_BASE, PAYROLL_REGION_URLS } from './constants.js';
 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;
@@ -21,7 +21,7 @@ const DEFAULT_PAGE_SIZE = 100;
  *
  * @example
  * ```typescript
- * const client = new EHClient({ apiKey: 'xxx', businessId: 123 });
+ * const client = new PayrollClient({ apiKey: 'xxx', businessId: 123 });
  *
  * // Validate credentials
  * await client.validateApiKey();
@@ -30,11 +30,11 @@ const DEFAULT_PAGE_SIZE = 100;
  * const { data: employees } = await client.getEmployees();
  * ```
  */
-export class EHClient {
+export class PayrollClient {
     constructor(config) {
         this.apiKey = config.apiKey;
         this.businessId = config.businessId;
-        this.baseUrl = config.baseUrl ?? (config.region ? EH_REGION_URLS[config.region] : EH_API_BASE);
+        this.baseUrl = config.baseUrl ?? (config.region ? PAYROLL_REGION_URLS[config.region] : PAYROLL_API_BASE);
         this.onRequest = config.onRequest;
         // Initialize cache if configured
         this.cache = resolveClientCache(config);
@@ -150,7 +150,7 @@ export class EHClient {
      * Fetch a URL and parse the response, with standardized error handling.
      */
     fetchAndParse(url, parse, fetchOptions) {
-        return fetchAndParseResponse(() => this.fetch(url, fetchOptions), parse, parseEHPayrollErrorResponse);
+        return fetchAndParseResponse(() => this.fetch(url, fetchOptions), parse, parsePayrollErrorResponse);
     }
     /**
      * Fetch all pages of a paginated endpoint.
@@ -172,7 +172,7 @@ export class EHClient {
                 const response = await this.fetch(url);
                 if (!response.ok) {
                     const errorText = await response.text();
-                    const { message } = parseEHPayrollErrorResponse(errorText, response.status);
+                    const { message } = parsePayrollErrorResponse(errorText, response.status);
                     return err(message, response.status);
                 }
                 const page = (await response.json())
@@ -258,10 +258,10 @@ export class EHClient {
                 params.set('GroupBy', options.groupBy);
             if (options?.restrictOverlappingLeave)
                 params.set('RestrictOverlappingLeave', 'true');
-            const url = this.businessUrl(ENTITIES.EHLeaveRequest.path, params);
+            const url = this.businessUrl(ENTITIES.PayrollLeaveRequest.path, params);
             return this.fetchAndParse(url, async (r) => {
                 return (await r.json())
-                    .map(item => pickFields(item, ENTITIES.EHLeaveRequest.fields));
+                    .map(item => pickFields(item, ENTITIES.PayrollLeaveRequest.fields));
             });
         }, this.restrictedPersistOpt);
     }
@@ -280,7 +280,7 @@ export class EHClient {
         if (options?.toDate)
             parts.push(`to:${options.toDate}`);
         const cacheKey = parts.join(':');
-        const entityPath = ENTITIES.EHEmployeeLeaveRequest.path.replace('{employeeId}', String(employeeId));
+        const entityPath = ENTITIES.PayrollEmployeeLeaveRequest.path.replace('{employeeId}', String(employeeId));
         return this.cached(cacheKey, this.cacheTtl.leaveRequestsTtl, () => {
             const params = new URLSearchParams();
             params.set('$top', String(DEFAULT_PAGE_SIZE));
@@ -296,7 +296,7 @@ export class EHClient {
             return this.fetchPaginated((skip) => {
                 params.set('$skip', String(skip));
                 return this.businessUrl(entityPath, params);
-            }, ENTITIES.EHEmployeeLeaveRequest.fields);
+            }, ENTITIES.PayrollEmployeeLeaveRequest.fields);
         }, this.restrictedPersistOpt);
     }
     // ============================================================================
@@ -321,8 +321,8 @@ export class EHClient {
             params.set('$top', String(DEFAULT_PAGE_SIZE));
             return this.fetchPaginated((skip) => {
                 params.set('$skip', String(skip));
-                return this.businessUrl(ENTITIES.EHEmployee.path, params);
-            }, ENTITIES.EHEmployee.fields);
+                return this.businessUrl(ENTITIES.PayrollEmployee.path, params);
+            }, ENTITIES.PayrollEmployee.fields);
         }, this.restrictedPersistOpt);
     }
     /**
@@ -330,9 +330,9 @@ export class EHClient {
      */
     async getEmployee(employeeId) {
         return this.cached(`employee:${employeeId}`, this.cacheTtl.employeesTtl, async () => {
-            const url = this.businessUrl(`${ENTITIES.EHEmployee.path}/${employeeId}`);
+            const url = this.businessUrl(`${ENTITIES.PayrollEmployee.path}/${employeeId}`);
             return this.fetchAndParse(url, async (r) => {
-                return pickFields(await r.json(), ENTITIES.EHEmployee.fields);
+                return pickFields(await r.json(), ENTITIES.PayrollEmployee.fields);
             });
         }, this.restrictedPersistOpt);
     }
@@ -375,8 +375,8 @@ export class EHClient {
             const params = new URLSearchParams({ '$top': String(DEFAULT_PAGE_SIZE) });
             return this.fetchPaginated((skip) => {
                 params.set('$skip', String(skip));
-                return this.businessUrl(ENTITIES.EHLocation.path, params);
-            }, ENTITIES.EHLocation.fields);
+                return this.businessUrl(ENTITIES.PayrollLocation.path, params);
+            }, ENTITIES.PayrollLocation.fields);
         });
     }
     // ============================================================================
@@ -390,8 +390,8 @@ export class EHClient {
             const params = new URLSearchParams({ '$top': String(DEFAULT_PAGE_SIZE) });
             return this.fetchPaginated((skip) => {
                 params.set('$skip', String(skip));
-                return this.businessUrl(ENTITIES.EHEmployeeGroup.path, params);
-            }, ENTITIES.EHEmployeeGroup.fields);
+                return this.businessUrl(ENTITIES.PayrollEmployeeGroup.path, params);
+            }, ENTITIES.PayrollEmployeeGroup.fields);
         });
     }
     // ============================================================================
@@ -473,8 +473,8 @@ export class EHClient {
                 params.set('IncludeWarnings', 'true');
             return this.fetchPaginated((skip) => {
                 params.set('CurrentPage', String(skip / DEFAULT_PAGE_SIZE + 1));
-                return this.businessUrl(ENTITIES.EHRosterShift.path, params);
-            }, ENTITIES.EHRosterShift.fields);
+                return this.businessUrl(ENTITIES.PayrollRosterShift.path, params);
+            }, ENTITIES.PayrollRosterShift.fields);
         });
     }
     // ============================================================================
@@ -488,8 +488,8 @@ export class EHClient {
             const params = new URLSearchParams({ '$top': String(DEFAULT_PAGE_SIZE) });
             return this.fetchPaginated((skip) => {
                 params.set('$skip', String(skip));
-                return this.businessUrl(ENTITIES.EHKiosk.path, params);
-            }, ENTITIES.EHKiosk.fields);
+                return this.businessUrl(ENTITIES.PayrollKiosk.path, params);
+            }, ENTITIES.PayrollKiosk.fields);
         });
     }
     /**
@@ -507,10 +507,10 @@ export class EHClient {
             if (options?.restrictCurrentShiftsToCurrentKioskLocation) {
                 params.set('restrictCurrentShiftsToCurrentKioskLocation', 'true');
             }
-            const url = this.businessUrl(ENTITIES.EHKioskEmployee.path.replace('{kioskId}', String(kioskId)), params);
+            const url = this.businessUrl(ENTITIES.PayrollKioskEmployee.path.replace('{kioskId}', String(kioskId)), params);
             return this.fetchAndParse(url, async (r) => {
                 return (await r.json())
-                    .map(item => pickFields(item, ENTITIES.EHKioskEmployee.fields));
+                    .map(item => pickFields(item, ENTITIES.PayrollKioskEmployee.fields));
             });
         });
     }

package/dist/constants.d.ts

@@ -2,8 +2,8 @@
  * Employment Hero Payroll Constants
  */
 /** Supported API regions */
-export type EHRegion = 'au' | 'nz' | 'uk' | 'sg' | 'my';
+export type PayrollRegion = 'au' | 'nz' | 'uk' | 'sg' | 'my';
 /** Base URLs for each region */
-export declare const EH_REGION_URLS: Record<EHRegion, string>;
-/** Default EH Payroll API base URL (AU) */
-export declare const EH_API_BASE: string;
+export declare const PAYROLL_REGION_URLS: Record<PayrollRegion, string>;
+/** Default Payroll API base URL (AU) */
+export declare const PAYROLL_API_BASE: string;

package/dist/constants.js

@@ -2,12 +2,12 @@
  * Employment Hero Payroll Constants
  */
 /** Base URLs for each region */
-export const EH_REGION_URLS = {
+export const PAYROLL_REGION_URLS = {
     au: 'https://api.yourpayroll.com.au/api/v2',
     nz: 'https://apinz.yourpayroll.io/api/v2',
     uk: 'https://api.yourpayroll.co.uk/api/v2',
     sg: 'https://apisg.yourpayroll.io/api/v2',
     my: 'https://apimy.yourpayroll.io/api/v2',
 };
-/** Default EH Payroll API base URL (AU) */
-export const EH_API_BASE = EH_REGION_URLS.au;
+/** Default Payroll API base URL (AU) */
+export const PAYROLL_API_BASE = PAYROLL_REGION_URLS.au;

package/dist/employee-types.generated.d.ts

@@ -6,14 +6,14 @@
  *
  * Total fields: 139
  */
-export type EHCloselyHeldReporting = 'PerQuarter' | 'PerPayRun';
-export type EHEmployeeStatus = 'Active' | 'Terminated' | 'Incomplete';
-export type EHLeaveAccrualStartDateType = 'EmployeeStartDate' | 'SpecifiedDate' | 'CalendarYear' | 'CategorySpecificDate';
-export type EHMedicareLevySurchargeWithholdingTier = 'Tier1' | 'Tier2' | 'Tier3';
-export type EHSingleTouchPayrollCategory = 'CloselyHeld' | 'ForeignEmployment' | 'InboundAssignee' | 'LabourHire' | 'OtherSpecifiedPayments' | 'SalaryAndWages' | 'WorkingHolidayMaker' | 'SeasonalWorker';
-export type EHTaxCategory = 'Actor_WithTaxFreeThreshold' | 'Actor_NoTaxFreeThreshold' | 'Actor_LimitedPerformancePerWeek' | 'Actor_Promotional' | 'HorticulturalistShearer_WithTaxFreeThreshold' | 'HorticulturalistShearer_ForeignResident' | 'SeniorPensioner_Single' | 'SeniorPensioner_Married' | 'SeniorPensioner_SeparatedCoupleIllness' | 'ATODefined_DeathBeneficiary' | 'ATODefined_DownwardVariation' | 'ATODefined_NonEmployee' | 'DailyCasual';
+export type PayrollCloselyHeldReporting = 'PerQuarter' | 'PerPayRun';
+export type PayrollEmployeeStatus = 'Active' | 'Terminated' | 'Incomplete';
+export type PayrollLeaveAccrualStartDateType = 'EmployeeStartDate' | 'SpecifiedDate' | 'CalendarYear' | 'CategorySpecificDate';
+export type PayrollMedicareLevySurchargeWithholdingTier = 'Tier1' | 'Tier2' | 'Tier3';
+export type PayrollSingleTouchPayrollCategory = 'CloselyHeld' | 'ForeignEmployment' | 'InboundAssignee' | 'LabourHire' | 'OtherSpecifiedPayments' | 'SalaryAndWages' | 'WorkingHolidayMaker' | 'SeasonalWorker';
+export type PayrollTaxCategory = 'Actor_WithTaxFreeThreshold' | 'Actor_NoTaxFreeThreshold' | 'Actor_LimitedPerformancePerWeek' | 'Actor_Promotional' | 'HorticulturalistShearer_WithTaxFreeThreshold' | 'HorticulturalistShearer_ForeignResident' | 'SeniorPensioner_Single' | 'SeniorPensioner_Married' | 'SeniorPensioner_SeparatedCoupleIllness' | 'ATODefined_DeathBeneficiary' | 'ATODefined_DownwardVariation' | 'ATODefined_NonEmployee' | 'DailyCasual';
 /** AU employee from unstructured endpoint (139 fields) */
-export interface EHEmployee {
+export interface PayrollEmployee {
     anniversaryDate: string | null;
     australianResident: boolean;
     automaticallyApplyPublicHolidayNotWorkedEarningsLines: boolean;
@@ -38,7 +38,7 @@ export interface EHEmployee {
     claimMedicareLevyReduction: boolean;
     claimTaxFreeThreshold: boolean;
     closelyHeldEmployee: boolean;
-    closelyHeldReporting: EHCloselyHeldReporting | null;
+    closelyHeldReporting: PayrollCloselyHeldReporting | null;
     contractorABN: string | null;
     dateCreated: string | null;
     dateOfBirth: string | null;
@@ -78,7 +78,7 @@ export interface EHEmployee {
     isExemptFromPayrollTax: boolean;
     isSeasonalWorker: boolean;
     jobTitle: string | null;
-    leaveAccrualStartDateType: EHLeaveAccrualStartDateType | null;
+    leaveAccrualStartDateType: PayrollLeaveAccrualStartDateType | null;
     leaveTemplate: string | null;
     leaveYearStart: string | null;
     locations: string | null;
@@ -86,7 +86,7 @@ export interface EHEmployee {
     medicareLevyExemption: string | null;
     medicareLevyReductionDependentCount: number | null;
     medicareLevyReductionSpouse: boolean;
-    medicareLevySurchargeWithholdingTier: EHMedicareLevySurchargeWithholdingTier | null;
+    medicareLevySurchargeWithholdingTier: PayrollMedicareLevySurchargeWithholdingTier | null;
     middleName: string | null;
     mobilePhone: string | null;
     otherTaxOffset: boolean;
@@ -119,9 +119,9 @@ export interface EHEmployee {
     residentialSuburb: string | null;
     rosteringNotificationChoices: string | null;
     seniorsTaxOffset: boolean;
-    singleTouchPayroll: EHSingleTouchPayrollCategory | null;
+    singleTouchPayroll: PayrollSingleTouchPayrollCategory | null;
     startDate: string | null;
-    status: EHEmployeeStatus | null;
+    status: PayrollEmployeeStatus | null;
     stslDebt: boolean;
     superFund1_AllocatedPercentage: number | null;
     superFund1_EmployerNominatedFund: boolean;
@@ -144,7 +144,7 @@ export interface EHEmployee {
     superThresholdAmount: number | null;
     surname: string | null;
     tags: string | null;
-    taxCategory: EHTaxCategory | null;
+    taxCategory: PayrollTaxCategory | null;
     taxFileNumber: string | null;
     taxVariation: number | null;
     terminationReason: string | null;

package/dist/errors.d.ts

@@ -11,7 +11,7 @@ import type { ParsedError } from '@markwharton/api-core';
 /**
  * Parsed EH error response
  */
-export type EHPayrollParsedError = ParsedError;
+export type PayrollParsedError = ParsedError;
 /**
  * Parse EH API error response text into a human-readable message.
  *
@@ -22,16 +22,16 @@ export type EHPayrollParsedError = ParsedError;
  * @param status - HTTP status code
  * @returns Parsed error with message
  */
-export declare function parseEHPayrollErrorResponse(errorText: string, status: number): EHPayrollParsedError;
+export declare function parsePayrollErrorResponse(errorText: string, status: number): PayrollParsedError;
 /**
  * Custom error class for EH API errors
  */
-export declare class EHPayrollError extends ApiError {
+export declare class PayrollError extends ApiError {
     constructor(message: string, status: number, options?: {
         rawResponse?: string;
     });
     /**
-     * Create an EHPayrollError from an API response
+     * Create an PayrollError from an API response
      */
-    static fromResponse(status: number, responseText: string): EHPayrollError;
+    static fromResponse(status: number, responseText: string): PayrollError;
 }

package/dist/errors.js

@@ -17,23 +17,23 @@ import { ApiError, parseJsonErrorResponse } from '@markwharton/api-core';
  * @param status - HTTP status code
  * @returns Parsed error with message
  */
-export function parseEHPayrollErrorResponse(errorText, status) {
+export function parsePayrollErrorResponse(errorText, status) {
     return parseJsonErrorResponse(errorText, status);
 }
 /**
  * Custom error class for EH API errors
  */
-export class EHPayrollError extends ApiError {
+export class PayrollError extends ApiError {
     constructor(message, status, options) {
         super(message, status, options);
-        this.name = 'EHPayrollError';
+        this.name = 'PayrollError';
     }
     /**
-     * Create an EHPayrollError from an API response
+     * Create an PayrollError from an API response
      */
     static fromResponse(status, responseText) {
-        const parsed = parseEHPayrollErrorResponse(responseText, status);
-        return new EHPayrollError(parsed.message, status, {
+        const parsed = parsePayrollErrorResponse(responseText, status);
+        return new PayrollError(parsed.message, status, {
             rawResponse: responseText,
         });
     }

package/dist/index.d.ts

@@ -5,9 +5,9 @@
  *
  * @example
  * ```typescript
- * import { EHClient } from '@markwharton/eh-payroll';
+ * import { PayrollClient } from '@markwharton/eh-payroll';
  *
- * const client = new EHClient({ apiKey: 'xxx', businessId: 123 });
+ * const client = new PayrollClient({ apiKey: 'xxx', businessId: 123 });
  *
  * // Validate credentials
  * await client.validateApiKey();
@@ -19,15 +19,22 @@
  * const { data: rosterShifts } = await client.getRosterShifts('2026-02-03', '2026-02-09');
  * ```
  */
-export { EHClient } from './client.js';
-export type { EHConfig, EHCacheConfig, EHRetryConfig, EHLeaveRequest, EHLeaveRequestOptions, EHLeaveRequestGroupBy, EHEmployeeLeaveRequestOptions, EHLeaveRequestStatus, EHEmployee, EHEmployeeStatus, EHLeaveAccrualStartDateType, EHCloselyHeldReporting, EHMedicareLevySurchargeWithholdingTier, EHSingleTouchPayrollCategory, EHTaxCategory, EHEmployeeOptions, EHStandardHours, EHLocation, EHEmployeeGroup, EHRosterShift, EHRosterShiftOptions, EHShiftStatus, EHAttendanceStatus, EHKiosk, EHKioskEmployee, EHKioskStaffOptions, EHEmployeeImage, } from './types.js';
-export { EMPLOYEE_FIELDS, LEAVE_REQUEST_FIELDS, LOCATION_FIELDS, EMPLOYEE_GROUP_FIELDS, ROSTER_SHIFT_FIELDS, KIOSK_FIELDS, KIOSK_EMPLOYEE_FIELDS, ENTITIES, } from './types.js';
+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 { AccessTier } from './types.js';
 export { METHOD_TIERS } from './types.js';
 export { buildBasicAuthHeader } from './utils.js';
 export { ok, err, getErrorMessage, pickFields, normalizeEnum, RateLimiter, TTLCache, MemoryCacheStore, LayeredCache } from '@markwharton/api-core';
 export type { Result, RetryConfig, OnRequestCallback, ClientConfig, Cache, CacheStore, CacheGetOptions } from '@markwharton/api-core';
-export { EH_API_BASE, EH_REGION_URLS } from './constants.js';
-export type { EHRegion } from './constants.js';
-export { EHPayrollError, parseEHPayrollErrorResponse } from './errors.js';
-export type { EHPayrollParsedError } from './errors.js';
+export { PAYROLL_API_BASE, PAYROLL_REGION_URLS } from './constants.js';
+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 { 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';
+export type { PayrollParsedError as EHPayrollParsedError } from './errors.js';

package/dist/index.js

@@ -5,9 +5,9 @@
  *
  * @example
  * ```typescript
- * import { EHClient } from '@markwharton/eh-payroll';
+ * import { PayrollClient } from '@markwharton/eh-payroll';
  *
- * const client = new EHClient({ apiKey: 'xxx', businessId: 123 });
+ * const client = new PayrollClient({ apiKey: 'xxx', businessId: 123 });
  *
  * // Validate credentials
  * await client.validateApiKey();
@@ -20,15 +20,26 @@
  * ```
  */
 // Main client
-export { EHClient } from './client.js';
+export { PayrollClient } from './client.js';
 // Field definitions (for pickFields)
-export { EMPLOYEE_FIELDS, LEAVE_REQUEST_FIELDS, LOCATION_FIELDS, EMPLOYEE_GROUP_FIELDS, ROSTER_SHIFT_FIELDS, KIOSK_FIELDS, KIOSK_EMPLOYEE_FIELDS, ENTITIES, } 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 { METHOD_TIERS } from './types.js';
 // Utilities
 export { buildBasicAuthHeader } from './utils.js';
 // Re-exported from @markwharton/api-core
 export { ok, err, getErrorMessage, pickFields, normalizeEnum, RateLimiter, TTLCache, MemoryCacheStore, LayeredCache } from '@markwharton/api-core';
 // Constants
-export { EH_API_BASE, EH_REGION_URLS } from './constants.js';
+export { PAYROLL_API_BASE, PAYROLL_REGION_URLS } from './constants.js';
 // Errors
-export { EHPayrollError, parseEHPayrollErrorResponse } from './errors.js';
+export { PayrollError, parsePayrollErrorResponse } from './errors.js';
+// ============================================================================
+// Backward compatibility aliases (deprecated — use Payroll* names)
+// ============================================================================
+// 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';
+// Constants
+export { PAYROLL_API_BASE as EH_API_BASE, PAYROLL_REGION_URLS as EH_REGION_URLS } from './constants.js';
+// Errors
+export { PayrollError as EHPayrollError, parsePayrollErrorResponse as parseEHPayrollErrorResponse } from './errors.js';

package/dist/types.d.ts

@@ -4,15 +4,15 @@
  * Types for the Employment Hero Payroll (KeyPay) API.
  * Based on the API reference and KeyPay .NET SDK models.
  */
-import type { EHRegion } from './constants.js';
+import type { PayrollRegion } from './constants.js';
 import type { RetryConfig, ClientConfig } from '@markwharton/api-core';
 /**
- * Cache configuration for EHClient
+ * Cache configuration for PayrollClient
  *
- * When provided to EHConfig, enables in-memory TTL caching of API responses.
+ * When provided to PayrollConfig, enables in-memory TTL caching of API responses.
  * All TTL values are in milliseconds. Omit individual TTLs to use defaults.
  */
-export interface EHCacheConfig {
+export interface PayrollCacheConfig {
     /** TTL for employee list (default: 300000 = 5 min) */
     employeesTtl?: number;
     /** TTL for leave requests (default: 120000 = 2 min) */
@@ -31,19 +31,19 @@ export interface EHCacheConfig {
     kioskStaffTtl?: number;
 }
 /** @deprecated Use `RetryConfig` from `@markwharton/api-core` directly. */
-export type EHRetryConfig = RetryConfig;
+export type PayrollRetryConfig = RetryConfig;
 /**
  * Employment Hero Payroll configuration for API access
  */
-export interface EHConfig extends ClientConfig {
+export interface PayrollConfig extends ClientConfig {
     /** API key for authentication (used as Basic Auth username) */
     apiKey: string;
     /** Business ID to operate on */
     businessId: number;
     /** API region (default: 'au'). Sets the base URL automatically. */
-    region?: EHRegion;
+    region?: PayrollRegion;
     /** Enable caching with optional TTL overrides. Omit to disable caching. */
-    cache?: EHCacheConfig;
+    cache?: PayrollCacheConfig;
     /** Max requests per second (default: 5 per API spec). Set 0 to disable. */
     rateLimitPerSecond?: number;
     /** Whether to persist restricted-tier data in persistent cache stores (default: true). Set false to keep restricted data in memory only. */
@@ -56,14 +56,14 @@ export interface EHConfig extends ClientConfig {
  *
  * @see employee-types.generated.ts
  */
-export type { EHEmployee, EHEmployeeStatus, EHLeaveAccrualStartDateType, EHCloselyHeldReporting, EHMedicareLevySurchargeWithholdingTier, EHSingleTouchPayrollCategory, EHTaxCategory, } from './employee-types.generated.js';
+export type { PayrollEmployee, PayrollEmployeeStatus, PayrollLeaveAccrualStartDateType, PayrollCloselyHeldReporting, PayrollMedicareLevySurchargeWithholdingTier, PayrollSingleTouchPayrollCategory, PayrollTaxCategory, } from './employee-types.generated.js';
 /**
  * Standard hours for an employee
  *
  * From GET /business/{id}/employee/{eid}/standardhours
  * Contains the FullTimeEquivalentHours field needed for FTE calculations.
  */
-export interface EHStandardHours {
+export interface PayrollStandardHours {
     /** Employee ID */
     employeeId: number;
     /** Standard hours per week */
@@ -78,7 +78,7 @@ export interface EHStandardHours {
  *
  * From GET /business/{id}/location
  */
-export interface EHLocation {
+export interface PayrollLocation {
     /** Location ID */
     id: number;
     /** Parent location ID (for hierarchy) */
@@ -101,7 +101,7 @@ export interface EHLocation {
 /**
  * Employee group
  */
-export interface EHEmployeeGroup {
+export interface PayrollEmployeeGroup {
     /** Group ID */
     id: number;
     /** Group name */
@@ -112,7 +112,7 @@ export interface EHEmployeeGroup {
  *
  * From GET /business/{id}/rostershift
  */
-export interface EHRosterShift {
+export interface PayrollRosterShift {
     /** Shift ID */
     id: number;
     /** Employee ID (null for unassigned shifts) */
@@ -141,13 +141,13 @@ export interface EHRosterShift {
 /**
  * Time and attendance status
  */
-export type EHAttendanceStatus = 'NotClockedOn' | 'ClockedOn' | 'OnBreak' | 'ClockedOff';
+export type PayrollAttendanceStatus = 'NotClockedOn' | 'ClockedOn' | 'OnBreak' | 'ClockedOff';
 /**
  * Kiosk employee from time and attendance
  *
  * From GET /business/{id}/kiosk/{kid}/staff
  */
-export interface EHKioskEmployee {
+export interface PayrollKioskEmployee {
     /** Employee ID */
     employeeId: number;
     /** First name */
@@ -157,7 +157,7 @@ export interface EHKioskEmployee {
     /** Full name */
     name: string | null;
     /** Attendance status */
-    status: EHAttendanceStatus;
+    status: PayrollAttendanceStatus;
     /** Clock-on time in UTC */
     clockOnTimeUtc: string | null;
     /** Break start time in UTC */
@@ -179,7 +179,7 @@ export interface EHKioskEmployee {
  * From GET /business/{id}/leaverequest
  * Fields from Swagger HourLeaveRequestResponseModel.
  */
-export interface EHLeaveRequest {
+export interface PayrollLeaveRequest {
     /** Leave request ID */
     id: number;
     /** Employee ID */
@@ -209,28 +209,28 @@ export interface EHLeaveRequest {
  * From GET /business/{id}/employee/{eid}/image
  * Returns binary data with content type.
  */
-export interface EHEmployeeImage {
+export interface PayrollEmployeeImage {
     /** Image data as ArrayBuffer */
     data: ArrayBuffer;
     /** Content type from response header (e.g., 'image/png') */
     contentType: string;
 }
 /** Leave request status values */
-export type EHLeaveRequestStatus = 'Approved' | 'Pending' | 'Rejected' | 'Cancelled';
+export type PayrollLeaveRequestStatus = 'Approved' | 'Pending' | 'Rejected' | 'Cancelled';
 /** Leave request grouping options */
-export type EHLeaveRequestGroupBy = 'Employee' | 'LeaveType';
+export type PayrollLeaveRequestGroupBy = 'Employee' | 'LeaveType';
 /**
  * Options for getLeaveRequests
  *
  * All filters are passed server-side to the API.
  */
-export interface EHLeaveRequestOptions {
+export interface PayrollLeaveRequestOptions {
     /** 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 status (→ API Status) */
-    status?: EHLeaveRequestStatus;
+    status?: PayrollLeaveRequestStatus;
     /** Filter by employee ID (→ API EmployeeId) */
     employeeId?: number;
     /** Filter by leave category ID (→ API LeaveCategoryId) */
@@ -238,7 +238,7 @@ export interface EHLeaveRequestOptions {
     /** Filter by location ID (→ API LocationId) */
     locationId?: number;
     /** Group results by 'Employee' or 'LeaveType' (→ API GroupBy) */
-    groupBy?: EHLeaveRequestGroupBy;
+    groupBy?: PayrollLeaveRequestGroupBy;
     /** Restrict results to leave overlapping the date range (→ API RestrictOverlappingLeave) */
     restrictOverlappingLeave?: boolean;
 }
@@ -247,9 +247,9 @@ export interface EHLeaveRequestOptions {
  *
  * Filters are passed as OData $filter to the per-employee endpoint.
  */
-export interface EHEmployeeLeaveRequestOptions {
+export interface PayrollEmployeeLeaveRequestOptions {
     /** Filter by status */
-    status?: EHLeaveRequestStatus;
+    status?: PayrollLeaveRequestStatus;
     /** Filter by start date (ISO 8601 date-time) */
     fromDate?: string;
     /** Filter by end date (ISO 8601 date-time) */
@@ -258,18 +258,18 @@ export interface EHEmployeeLeaveRequestOptions {
 /**
  * Options for getEmployees
  */
-export interface EHEmployeeOptions {
+export interface PayrollEmployeeOptions {
     /** Filter by pay schedule ID */
     payScheduleId?: number;
     /** Filter by location ID */
     locationId?: number;
 }
 /** Roster shift status filter values */
-export type EHShiftStatus = 'All' | 'Published' | 'Unpublished' | 'Accepted';
+export type PayrollShiftStatus = 'All' | 'Published' | 'Unpublished' | 'Accepted';
 /**
  * Options for getRosterShifts
  */
-export interface EHRosterShiftOptions {
+export interface PayrollRosterShiftOptions {
     /** Filter by employee ID */
     employeeId?: number;
     /** Filter by location ID */
@@ -279,9 +279,9 @@ export interface EHRosterShiftOptions {
     /** Include shifts with all roles (default: only unassigned roles) */
     selectAllRoles?: boolean;
     /** Filter by single shift status */
-    shiftStatus?: EHShiftStatus;
+    shiftStatus?: PayrollShiftStatus;
     /** Filter by multiple shift statuses */
-    shiftStatuses?: EHShiftStatus[];
+    shiftStatuses?: PayrollShiftStatus[];
     /** Filter by specific locations (multiple) */
     selectedLocations?: string[];
     /** Filter by specific employees (multiple) */
@@ -300,7 +300,7 @@ export interface EHRosterShiftOptions {
  *
  * From GET /business/{id}/kiosk
  */
-export interface EHKiosk {
+export interface PayrollKiosk {
     /** Kiosk ID */
     id: number;
     /** External identifier */
@@ -337,12 +337,12 @@ export interface EHKiosk {
 /**
  * Options for getKioskStaff
  */
-export interface EHKioskStaffOptions {
+export interface PayrollKioskStaffOptions {
     /** Restrict current shifts to current kiosk location (default: false) */
     restrictCurrentShiftsToCurrentKioskLocation?: boolean;
 }
-/** Fields for EHLeaveRequest — set false to exclude from API responses */
-export declare const LEAVE_REQUEST_FIELDS: {
+/** Fields for PayrollLeaveRequest — set false to exclude from API responses */
+export declare const PAYROLL_LEAVE_REQUEST_FIELDS: {
     readonly id: true;
     readonly employeeId: true;
     readonly leaveCategoryId: true;
@@ -355,8 +355,8 @@ export declare const LEAVE_REQUEST_FIELDS: {
     readonly notes: true;
     readonly status: true;
 };
-/** Fields for EHLocation — set false to exclude from API responses */
-export declare const LOCATION_FIELDS: {
+/** Fields for PayrollLocation — set false to exclude from API responses */
+export declare const PAYROLL_LOCATION_FIELDS: {
     readonly id: true;
     readonly parentId: true;
     readonly name: true;
@@ -367,8 +367,8 @@ export declare const LOCATION_FIELDS: {
     readonly state: true;
     readonly country: true;
 };
-/** Fields for EHKiosk — set false to exclude from API responses */
-export declare const KIOSK_FIELDS: {
+/** Fields for PayrollKiosk — set false to exclude from API responses */
+export declare const PAYROLL_KIOSK_FIELDS: {
     readonly id: true;
     readonly externalId: true;
     readonly name: true;
@@ -386,8 +386,8 @@ export declare const KIOSK_FIELDS: {
     readonly canAddEmployees: true;
     readonly paidBreaksEnabled: true;
 };
-/** Fields for EHKioskEmployee — set false to exclude from API responses */
-export declare const KIOSK_EMPLOYEE_FIELDS: {
+/** Fields for PayrollKioskEmployee — set false to exclude from API responses */
+export declare const PAYROLL_KIOSK_EMPLOYEE_FIELDS: {
     readonly employeeId: true;
     readonly firstName: true;
     readonly surname: true;
@@ -401,13 +401,13 @@ export declare const KIOSK_EMPLOYEE_FIELDS: {
     readonly longShift: true;
     readonly recordedTimeUtc: true;
 };
-/** Fields for EHEmployeeGroup — set false to exclude from API responses */
-export declare const EMPLOYEE_GROUP_FIELDS: {
+/** Fields for PayrollEmployeeGroup — set false to exclude from API responses */
+export declare const PAYROLL_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: {
+/** Fields for PayrollRosterShift — set false to exclude from API responses */
+export declare const PAYROLL_ROSTER_SHIFT_FIELDS: {
     readonly id: true;
     readonly employeeId: true;
     readonly employeeName: true;
@@ -421,8 +421,8 @@ export declare const ROSTER_SHIFT_FIELDS: {
     readonly published: true;
     readonly accepted: true;
 };
-/** Fields for EHEmployee — set false to exclude from API responses */
-export declare const EMPLOYEE_FIELDS: {
+/** Fields for PayrollEmployee — set false to exclude from API responses */
+export declare const PAYROLL_EMPLOYEE_FIELDS: {
     readonly id: true;
     readonly externalId: true;
     readonly firstName: true;

package/dist/types.js

@@ -7,42 +7,42 @@
 // ============================================================================
 // Field Definitions (for pickFields)
 // ============================================================================
-/** Fields for EHLeaveRequest — set false to exclude from API responses */
-export const LEAVE_REQUEST_FIELDS = {
+/** Fields for PayrollLeaveRequest — set false to exclude from API responses */
+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 EHLocation — set false to exclude from API responses */
-export const LOCATION_FIELDS = {
+/** 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,
     fullyQualifiedName: true, isGlobal: true, state: true, country: true,
 };
-/** Fields for EHKiosk — set false to exclude from API responses */
-export const KIOSK_FIELDS = {
+/** Fields for PayrollKiosk — set false to exclude from API responses */
+export const PAYROLL_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 = {
+/** Fields for PayrollKioskEmployee — set false to exclude from API responses */
+export const PAYROLL_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 = {
+/** Fields for PayrollEmployeeGroup — set false to exclude from API responses */
+export const PAYROLL_EMPLOYEE_GROUP_FIELDS = {
     id: true, name: true,
 };
-/** Fields for EHRosterShift — set false to exclude from API responses */
-export const ROSTER_SHIFT_FIELDS = {
+/** Fields for PayrollRosterShift — set false to exclude from API responses */
+export const PAYROLL_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 EHEmployee — set false to exclude from API responses */
-export const EMPLOYEE_FIELDS = {
+/** Fields for PayrollEmployee — set false to exclude from API responses */
+export const PAYROLL_EMPLOYEE_FIELDS = {
     // Identity
     id: true, externalId: true, firstName: true, surname: true, status: true,
     // Dates
@@ -111,16 +111,26 @@ export const EMPLOYEE_FIELDS = {
 };
 /** Entity registry — maps interface names to field specs and API path segments. */
 export const ENTITIES = {
-    EHEmployee: { fields: EMPLOYEE_FIELDS, path: 'employee/unstructured', apiRef: 'employee/au-employee--get-employees', apiRefById: 'employee/au-employee--get-employee-by-id' },
-    EHLeaveRequest: { fields: LEAVE_REQUEST_FIELDS, path: 'leaverequest', apiRef: 'leave-requests/au-business-hours-leave-request--list-leave-requests' },
-    EHEmployeeLeaveRequest: { fields: LEAVE_REQUEST_FIELDS, path: 'employee/{employeeId}/leaverequest', apiRef: 'leave-requests/au-hours-leave-request--get-leave-requests' },
-    EHLocation: { fields: LOCATION_FIELDS, path: 'location', apiRef: 'location/au-location--get-locations' },
-    EHRosterShift: { fields: ROSTER_SHIFT_FIELDS, path: 'rostershift', apiRef: 'roster-shifts/au-roster-shift--get' },
-    EHKiosk: { fields: KIOSK_FIELDS, path: 'kiosk', apiRef: 'time-and-attendance/kiosk--get-all' },
-    EHKioskEmployee: { fields: KIOSK_EMPLOYEE_FIELDS, path: 'kiosk/{kioskId}/staff', apiRef: 'time-and-attendance/generic-time-and-attendance--get-staff' },
-    EHEmployeeGroup: { fields: 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' },
+    PayrollEmployee: { fields: PAYROLL_EMPLOYEE_FIELDS, path: 'employee/unstructured', apiRef: 'employee/au-employee--get-employees', apiRefById: 'employee/au-employee--get-employee-by-id' },
+    PayrollLeaveRequest: { fields: PAYROLL_LEAVE_REQUEST_FIELDS, path: 'leaverequest', apiRef: 'leave-requests/au-business-hours-leave-request--list-leave-requests' },
+    PayrollEmployeeLeaveRequest: { fields: PAYROLL_LEAVE_REQUEST_FIELDS, path: 'employee/{employeeId}/leaverequest', apiRef: 'leave-requests/au-hours-leave-request--get-leave-requests' },
+    PayrollLocation: { fields: PAYROLL_LOCATION_FIELDS, path: 'location', apiRef: 'location/au-location--get-locations' },
+    PayrollRosterShift: { fields: PAYROLL_ROSTER_SHIFT_FIELDS, path: 'rostershift', apiRef: 'roster-shifts/au-roster-shift--get' },
+    PayrollKiosk: { fields: PAYROLL_KIOSK_FIELDS, path: 'kiosk', apiRef: 'time-and-attendance/kiosk--get-all' },
+    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' },
 };
+// Backward compatibility aliases for ENTITIES keys
+ENTITIES.EHEmployee = ENTITIES.PayrollEmployee;
+ENTITIES.EHLeaveRequest = ENTITIES.PayrollLeaveRequest;
+ENTITIES.EHEmployeeLeaveRequest = ENTITIES.PayrollEmployeeLeaveRequest;
+ENTITIES.EHLocation = ENTITIES.PayrollLocation;
+ENTITIES.EHRosterShift = ENTITIES.PayrollRosterShift;
+ENTITIES.EHKiosk = ENTITIES.PayrollKiosk;
+ENTITIES.EHKioskEmployee = ENTITIES.PayrollKioskEmployee;
+ENTITIES.EHEmployeeGroup = ENTITIES.PayrollEmployeeGroup;
+ENTITIES.EHStandardHours = ENTITIES.PayrollStandardHours;
 /**
  * Access tier for each data method.
  *

package/package.json

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

package/dist/cache.d.ts

@@ -1,38 +0,0 @@
-/**
- * Simple in-memory TTL cache with request coalescing
- *
- * Provides per-instance memoization for EHClient API responses.
- * In serverless environments (Azure Functions, Static Web Apps),
- * module-level state persists across warm invocations within the
- * same instance — this cache leverages that behavior.
- *
- * Request coalescing: when multiple concurrent callers request the
- * same expired key, only one factory call is made. All callers
- * receive the same resolved value (or the same rejection).
- *
- * Not a distributed cache: each instance has its own cache.
- * Cold starts and instance recycling naturally clear stale data.
- */
-export declare class TTLCache {
-    private store;
-    private inflight;
-    /**
-     * Get a cached value, or call the factory to populate it.
-     *
-     * If a factory call is already in progress for this key,
-     * returns the existing promise instead of starting a duplicate.
-     *
-     * @param key - Cache key
-     * @param ttlMs - Time-to-live in milliseconds
-     * @param factory - Async function to produce the value on cache miss
-     */
-    get<T>(key: string, ttlMs: number, factory: () => Promise<T>): Promise<T>;
-    /**
-     * Invalidate cache entries matching a key prefix.
-     */
-    invalidate(prefix: string): void;
-    /**
-     * Clear all cached data and in-flight requests.
-     */
-    clear(): void;
-}

package/dist/cache.js

@@ -1,73 +0,0 @@
-/**
- * Simple in-memory TTL cache with request coalescing
- *
- * Provides per-instance memoization for EHClient API responses.
- * In serverless environments (Azure Functions, Static Web Apps),
- * module-level state persists across warm invocations within the
- * same instance — this cache leverages that behavior.
- *
- * Request coalescing: when multiple concurrent callers request the
- * same expired key, only one factory call is made. All callers
- * receive the same resolved value (or the same rejection).
- *
- * Not a distributed cache: each instance has its own cache.
- * Cold starts and instance recycling naturally clear stale data.
- */
-export class TTLCache {
-    constructor() {
-        this.store = new Map();
-        this.inflight = new Map();
-    }
-    /**
-     * Get a cached value, or call the factory to populate it.
-     *
-     * If a factory call is already in progress for this key,
-     * returns the existing promise instead of starting a duplicate.
-     *
-     * @param key - Cache key
-     * @param ttlMs - Time-to-live in milliseconds
-     * @param factory - Async function to produce the value on cache miss
-     */
-    async get(key, ttlMs, factory) {
-        const existing = this.store.get(key);
-        if (existing && existing.expiresAt > Date.now()) {
-            return existing.data;
-        }
-        const pending = this.inflight.get(key);
-        if (pending) {
-            return pending;
-        }
-        const promise = factory().then((data) => {
-            this.store.set(key, { data, expiresAt: Date.now() + ttlMs });
-            this.inflight.delete(key);
-            return data;
-        }, (err) => {
-            this.inflight.delete(key);
-            throw err;
-        });
-        this.inflight.set(key, promise);
-        return promise;
-    }
-    /**
-     * Invalidate cache entries matching a key prefix.
-     */
-    invalidate(prefix) {
-        for (const key of this.store.keys()) {
-            if (key.startsWith(prefix)) {
-                this.store.delete(key);
-            }
-        }
-        for (const key of this.inflight.keys()) {
-            if (key.startsWith(prefix)) {
-                this.inflight.delete(key);
-            }
-        }
-    }
-    /**
-     * Clear all cached data and in-flight requests.
-     */
-    clear() {
-        this.store.clear();
-        this.inflight.clear();
-    }
-}

package/dist/rate-limiter.d.ts

@@ -1,33 +0,0 @@
-/**
- * Sliding window rate limiter
- *
- * Enforces a maximum number of requests per time window.
- * Callers that exceed the limit are queued and released when capacity opens.
- *
- * Uses a sliding window approach: tracks timestamps of recent requests and
- * checks that no more than `maxRequests` fall within any `windowMs` period.
- *
- * Thread-safe in single-threaded JS — no races between concurrent acquire() calls.
- */
-export declare class RateLimiter {
-    private maxRequests;
-    private windowMs;
-    private timestamps;
-    private queue;
-    private timer;
-    /**
-     * @param maxRequests - Maximum requests allowed per window
-     * @param windowMs - Window size in milliseconds (default: 1000)
-     */
-    constructor(maxRequests: number, windowMs?: number);
-    /**
-     * Acquire a rate limit token.
-     *
-     * Resolves immediately if under the limit, otherwise queues until capacity opens.
-     */
-    acquire(): Promise<void>;
-    /** Remove timestamps outside the current window */
-    private pruneTimestamps;
-    /** Schedule a flush to release queued callers when the oldest timestamp expires */
-    private scheduleFlush;
-}

package/dist/rate-limiter.js

@@ -1,63 +0,0 @@
-/**
- * Sliding window rate limiter
- *
- * Enforces a maximum number of requests per time window.
- * Callers that exceed the limit are queued and released when capacity opens.
- *
- * Uses a sliding window approach: tracks timestamps of recent requests and
- * checks that no more than `maxRequests` fall within any `windowMs` period.
- *
- * Thread-safe in single-threaded JS — no races between concurrent acquire() calls.
- */
-export class RateLimiter {
-    /**
-     * @param maxRequests - Maximum requests allowed per window
-     * @param windowMs - Window size in milliseconds (default: 1000)
-     */
-    constructor(maxRequests, windowMs = 1000) {
-        this.maxRequests = maxRequests;
-        this.windowMs = windowMs;
-        this.timestamps = [];
-        this.queue = [];
-        this.timer = null;
-    }
-    /**
-     * Acquire a rate limit token.
-     *
-     * Resolves immediately if under the limit, otherwise queues until capacity opens.
-     */
-    acquire() {
-        this.pruneTimestamps();
-        if (this.timestamps.length < this.maxRequests) {
-            this.timestamps.push(Date.now());
-            return Promise.resolve();
-        }
-        return new Promise(resolve => {
-            this.queue.push({ resolve });
-            this.scheduleFlush();
-        });
-    }
-    /** Remove timestamps outside the current window */
-    pruneTimestamps() {
-        const cutoff = Date.now() - this.windowMs;
-        this.timestamps = this.timestamps.filter(t => t > cutoff);
-    }
-    /** Schedule a flush to release queued callers when the oldest timestamp expires */
-    scheduleFlush() {
-        if (this.timer || this.queue.length === 0 || this.timestamps.length === 0)
-            return;
-        const oldest = this.timestamps[0];
-        const delay = Math.max(0, this.windowMs - (Date.now() - oldest) + 1);
-        this.timer = setTimeout(() => {
-            this.timer = null;
-            this.pruneTimestamps();
-            while (this.queue.length > 0 && this.timestamps.length < this.maxRequests) {
-                this.timestamps.push(Date.now());
-                this.queue.shift().resolve();
-            }
-            if (this.queue.length > 0) {
-                this.scheduleFlush();
-            }
-        }, delay);
-    }
-}