@markwharton/eh-payroll 3.0.1 → 3.2.0

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

@@ -4,26 +4,48 @@
  * Generated from KeyPay AU Swagger spec. DO NOT EDIT MANUALLY.
  * Run: npx tsx scripts/generate-types.ts
  *
- * Common fields: 69, AU-specific: 70
+ * Total fields: 139
  */
-/** Common fields shared across all 5 regions (69 fields) */
-export interface EHEmployeeCommon {
+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 PayrollEmployee {
     anniversaryDate: string | null;
+    australianResident: boolean;
+    automaticallyApplyPublicHolidayNotWorkedEarningsLines: boolean;
     automaticallyPayEmployee: string | null;
+    awardId: number | null;
     bankAccount1_AccountName: string | null;
     bankAccount1_AccountNumber: string | null;
     bankAccount1_AllocatedPercentage: number | null;
+    bankAccount1_BSB: string | null;
     bankAccount1_FixedAmount: number | null;
     bankAccount2_AccountName: string | null;
     bankAccount2_AccountNumber: string | null;
     bankAccount2_AllocatedPercentage: number | null;
+    bankAccount2_BSB: string | null;
     bankAccount2_FixedAmount: number | null;
     bankAccount3_AccountName: string | null;
     bankAccount3_AccountNumber: string | null;
     bankAccount3_AllocatedPercentage: number | null;
+    bankAccount3_BSB: string | null;
     bankAccount3_FixedAmount: number | null;
+    businessAwardPackage: string | null;
+    claimMedicareLevyReduction: boolean;
+    claimTaxFreeThreshold: boolean;
+    closelyHeldEmployee: boolean;
+    closelyHeldReporting: PayrollCloselyHeldReporting | null;
+    contractorABN: string | null;
     dateCreated: string | null;
     dateOfBirth: string | null;
+    dateTaxFileDeclarationReported: string | null;
+    dateTaxFileDeclarationSigned: string | null;
+    disableAutoProgression: boolean;
+    dvlPaySlipDescription: string | null;
     emailAddress: string | null;
     emergencyContact1_Address: string | null;
     emergencyContact1_AlternateContactNumber: string | null;
@@ -35,95 +57,71 @@ export interface EHEmployeeCommon {
     emergencyContact2_ContactNumber: string | null;
     emergencyContact2_Name: string | null;
     emergencyContact2_Relationship: string | null;
+    employingEntityABN: string | null;
+    employingEntityId: string | null;
+    employmentAgreement: string | null;
+    employmentAgreementId: number | null;
+    employmentType: string | null;
     endDate: string | null;
     externalId: string | null;
     firstName: string | null;
     gender: string | null;
+    hasApprovedWorkingHolidayVisa: boolean;
+    hasWithholdingVariation: boolean;
     homePhone: string | null;
+    hoursPerDay: number | null;
     hoursPerWeek: number | null;
     id: number | null;
+    includeInPortableLongServiceLeaveReport: boolean;
     isEnabledForTimesheets: string | null;
+    isExemptFromFloodLevy: boolean;
+    isExemptFromPayrollTax: boolean;
+    isSeasonalWorker: boolean;
     jobTitle: string | null;
-    leaveAccrualStartDateType: 'EmployeeStartDate' | 'SpecifiedDate' | 'CalendarYear' | 'CategorySpecificDate' | null;
+    leaveAccrualStartDateType: PayrollLeaveAccrualStartDateType | null;
     leaveTemplate: string | null;
     leaveYearStart: string | null;
     locations: string | null;
+    maximumQuarterlySuperContributionsBase: number | null;
+    medicareLevyExemption: string | null;
+    medicareLevyReductionDependentCount: number | null;
+    medicareLevyReductionSpouse: boolean;
+    medicareLevySurchargeWithholdingTier: PayrollMedicareLevySurchargeWithholdingTier | null;
     middleName: string | null;
     mobilePhone: string | null;
+    otherTaxOffset: boolean;
     overrideTemplateRate: string | null;
     payConditionRuleSet: string | null;
     payRateTemplate: string | null;
     paySchedule: string | null;
     paySlipNotificationType: string | null;
+    portableLongServiceLeaveId: string | null;
+    postalAddressIsOverseas: boolean;
     postalAddressLine2: string | null;
     postalCountry: string | null;
     postalPostCode: string | null;
+    postalState: string | null;
     postalStreetAddress: string | null;
+    postalSuburb: string | null;
     preferredName: string | null;
+    previousSurname: string | null;
     primaryLocation: string | null;
     primaryPayCategory: string | null;
     rate: number | null;
     rateUnit: string | null;
     reportingDimensionValues: string | null;
+    residentialAddressIsOverseas: boolean;
     residentialAddressLine2: string | null;
     residentialCountry: string | null;
     residentialPostCode: string | null;
-    residentialStreetAddress: string | null;
-    rosteringNotificationChoices: string | null;
-    startDate: string | null;
-    status: 'Active' | 'Terminated' | 'Incomplete' | null;
-    surname: string | null;
-    tags: string | null;
-    title: string | null;
-    workPhone: string | null;
-    workTypes: string | null;
-}
-/** AU region employee (70 region-specific fields) */
-export interface EHEmployee extends EHEmployeeCommon {
-    australianResident: boolean;
-    automaticallyApplyPublicHolidayNotWorkedEarningsLines: boolean;
-    awardId: number | null;
-    bankAccount1_BSB: string | null;
-    bankAccount2_BSB: string | null;
-    bankAccount3_BSB: string | null;
-    businessAwardPackage: string | null;
-    claimMedicareLevyReduction: boolean;
-    claimTaxFreeThreshold: boolean;
-    closelyHeldEmployee: boolean;
-    closelyHeldReporting: 'PerQuarter' | 'PerPayRun' | null;
-    contractorABN: string | null;
-    dateTaxFileDeclarationReported: string | null;
-    dateTaxFileDeclarationSigned: string | null;
-    disableAutoProgression: boolean;
-    dvlPaySlipDescription: string | null;
-    employingEntityABN: string | null;
-    employingEntityId: string | null;
-    employmentAgreement: string | null;
-    employmentAgreementId: number | null;
-    employmentType: string | null;
-    hasApprovedWorkingHolidayVisa: boolean;
-    hasWithholdingVariation: boolean;
-    hoursPerDay: number | null;
-    includeInPortableLongServiceLeaveReport: boolean;
-    isExemptFromFloodLevy: boolean;
-    isExemptFromPayrollTax: boolean;
-    isSeasonalWorker: boolean;
-    maximumQuarterlySuperContributionsBase: number | null;
-    medicareLevyExemption: string | null;
-    medicareLevyReductionDependentCount: number | null;
-    medicareLevyReductionSpouse: boolean;
-    medicareLevySurchargeWithholdingTier: 'Tier1' | 'Tier2' | 'Tier3' | null;
-    otherTaxOffset: boolean;
-    portableLongServiceLeaveId: string | null;
-    postalAddressIsOverseas: boolean;
-    postalState: string | null;
-    postalSuburb: string | null;
-    previousSurname: string | null;
-    residentialAddressIsOverseas: boolean;
     residentialState: string | null;
+    residentialStreetAddress: string | null;
     residentialSuburb: string | null;
+    rosteringNotificationChoices: string | null;
     seniorsTaxOffset: boolean;
-    singleTouchPayroll: 'CloselyHeld' | 'ForeignEmployment' | 'InboundAssignee' | 'LabourHire' | 'OtherSpecifiedPayments' | null;
+    singleTouchPayroll: PayrollSingleTouchPayrollCategory | null;
+    startDate: string | null;
+    status: PayrollEmployeeStatus | null;
     stslDebt: boolean;
     superFund1_AllocatedPercentage: number | null;
     superFund1_EmployerNominatedFund: boolean;
@@ -144,10 +142,15 @@ export interface EHEmployee extends EHEmployeeCommon {
     superFund3_MemberNumber: string | null;
     superFund3_ProductCode: string | null;
     superThresholdAmount: number | null;
-    taxCategory: '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' | null;
+    surname: string | null;
+    tags: string | null;
+    taxCategory: PayrollTaxCategory | null;
     taxFileNumber: string | null;
     taxVariation: number | null;
     terminationReason: string | null;
+    title: string | null;
     workingHolidayVisaCountry: string | null;
     workingHolidayVisaStartDate: string | null;
+    workPhone: string | null;
+    workTypes: string | null;
 }

package/dist/employee-types.generated.js

@@ -1,9 +1 @@
-/**
- * Auto-generated AU employee type.
- *
- * Generated from KeyPay AU Swagger spec. DO NOT EDIT MANUALLY.
- * Run: npx tsx scripts/generate-types.ts
- *
- * Common fields: 69, AU-specific: 70
- */
 export {};