@markwharton/eh-payroll 1.2.0 → 2.0.0

package/README.md

@@ -38,6 +38,12 @@ const { rosterShifts: published } = await client.getRosterShifts('2026-02-03', '
   selectAllRoles: true
 });
 
+// Get business locations
+const { locations } = await client.getLocations();
+
+// List kiosks
+const { kiosks } = await client.getKiosks();
+
 // Get kiosk staff (time and attendance)
 const { staff } = await client.getKioskStaff(kioskId);
 
@@ -66,8 +72,10 @@ All methods return `{ data?, error? }` result objects rather than throwing excep
 | `getEmployees(options?)` | `EHEmployeeOptions?` | `{ employees?, error? }` |
 | `getEmployee(employeeId)` | `number` | `{ employee?, error? }` |
 | `getStandardHours(employeeId)` | `number` | `{ standardHours?, error? }` |
+| `getLocations()` | — | `{ locations?, error? }` |
 | `getEmployeeGroups()` | — | `{ employeeGroups?, error? }` |
 | `getRosterShifts(from, to, options?)` | `string, string, EHRosterShiftOptions?` | `{ rosterShifts?, error? }` |
+| `getKiosks()` | — | `{ kiosks?, error? }` |
 | `getKioskStaff(kioskId, options?)` | `number, EHKioskStaffOptions?` | `{ staff?, error? }` |
 | `getReportFields()` | — | `{ fields?, error? }` |
 | `getEmployeeDetailsReport(options?)` | `EHEmployeeDetailsReportOptions?` | `{ records?, error? }` |
@@ -104,9 +112,12 @@ const client = new EHClient({
 | Cache Key | Default TTL |
 |-----------|-------------|
 | Employees | 5 min |
+| Locations | 5 min |
 | Employee groups | 5 min |
 | Standard hours | 5 min |
 | Roster shifts | 2 min |
+| Kiosks | 5 min |
+| Kiosk staff | 1 min |
 | Report fields | 10 min |
 
 ### Rate Limiting

package/dist/client.d.ts

@@ -6,8 +6,9 @@
  *
  * @see https://api.keypay.com.au/
  */
-import type { EHConfig, EHEmployeeOptions, EHSingleEmployeeOptions, EHStandardHours, EHEmployeeGroup, EHRosterShift, EHRosterShiftOptions, EHKioskEmployee, EHKioskStaffOptions, EHErrorInfo, EHReportField, EHEmployeeDetailsReportOptions } from './types.js';
+import type { EHConfig, EHEmployeeOptions, EHSingleEmployeeOptions, EHStandardHours, EHLocation, EHEmployeeGroup, EHRosterShift, EHRosterShiftOptions, EHKiosk, EHKioskEmployee, EHKioskStaffOptions, EHReportField, EHEmployeeDetailsReportOptions } from './types.js';
 import type { EHAuEmployee } from './employee-types.generated.js';
+import type { Result } from '@markwharton/api-core';
 /**
  * Employment Hero Payroll API Client
  *
@@ -19,7 +20,7 @@ import type { EHAuEmployee } from './employee-types.generated.js';
  * await client.validateApiKey();
  *
  * // Get employees
- * const { employees } = await client.getEmployees();
+ * const { data: employees } = await client.getEmployees();
  * ```
  */
 export declare class EHClient {
@@ -54,38 +55,27 @@ export declare class EHClient {
     /**
      * Validate the API key by calling GET /user
      */
-    validateApiKey(): Promise<{
-        valid: boolean;
-        error?: string;
-    }>;
+    validateApiKey(): Promise<Result<void>>;
     /**
      * Get all employees (unstructured format)
      */
-    getEmployees(options?: EHEmployeeOptions): Promise<{
-        employees?: EHAuEmployee[];
-        error?: EHErrorInfo;
-    }>;
+    getEmployees(options?: EHEmployeeOptions): Promise<Result<EHAuEmployee[]>>;
     /**
      * Get a single employee by ID
      */
-    getEmployee(employeeId: number, options?: EHSingleEmployeeOptions): Promise<{
-        employee?: EHAuEmployee;
-        error?: EHErrorInfo;
-    }>;
+    getEmployee(employeeId: number, options?: EHSingleEmployeeOptions): Promise<Result<EHAuEmployee>>;
     /**
      * Get standard hours for an employee (includes FTE value)
      */
-    getStandardHours(employeeId: number): Promise<{
-        standardHours?: EHStandardHours;
-        error?: EHErrorInfo;
-    }>;
+    getStandardHours(employeeId: number): Promise<Result<EHStandardHours>>;
+    /**
+     * Get all business locations
+     */
+    getLocations(): Promise<Result<EHLocation[]>>;
     /**
      * Get all employee groups
      */
-    getEmployeeGroups(): Promise<{
-        employeeGroups?: EHEmployeeGroup[];
-        error?: EHErrorInfo;
-    }>;
+    getEmployeeGroups(): Promise<Result<EHEmployeeGroup[]>>;
     /**
      * Get roster shifts for a date range
      *
@@ -93,38 +83,30 @@ export declare class EHClient {
      * @param toDate - End date (YYYY-MM-DD)
      * @param options - Optional filters
      */
-    getRosterShifts(fromDate: string, toDate: string, options?: EHRosterShiftOptions): Promise<{
-        rosterShifts?: EHRosterShift[];
-        error?: EHErrorInfo;
-    }>;
+    getRosterShifts(fromDate: string, toDate: string, options?: EHRosterShiftOptions): Promise<Result<EHRosterShift[]>>;
+    /**
+     * Get all kiosks for the business
+     */
+    getKiosks(): Promise<Result<EHKiosk[]>>;
     /**
      * Get kiosk staff for time and attendance
      *
      * @param kioskId - Kiosk identifier
      * @param options - Optional query parameters
      */
-    getKioskStaff(kioskId: number, options?: EHKioskStaffOptions): Promise<{
-        staff?: EHKioskEmployee[];
-        error?: EHErrorInfo;
-    }>;
+    getKioskStaff(kioskId: number, options?: EHKioskStaffOptions): Promise<Result<EHKioskEmployee[]>>;
     /**
      * Get available fields for the Employee Details Report
      *
      * Returns the list of columns that can be requested via getEmployeeDetailsReport().
      * Use this to discover what data is available for the business.
      */
-    getReportFields(): Promise<{
-        fields?: EHReportField[];
-        error?: EHErrorInfo;
-    }>;
+    getReportFields(): Promise<Result<EHReportField[]>>;
     /**
      * Get Employee Details Report
      *
      * Returns all employees with the requested columns in a single API call.
      * The response is dynamic (JObject[]) — field keys depend on selectedColumns.
      */
-    getEmployeeDetailsReport(options?: EHEmployeeDetailsReportOptions): Promise<{
-        records?: Record<string, unknown>[];
-        error?: EHErrorInfo;
-    }>;
+    getEmployeeDetailsReport(options?: EHEmployeeDetailsReportOptions): Promise<Result<Record<string, unknown>[]>>;
 }

package/dist/client.js

@@ -6,11 +6,11 @@
  *
  * @see https://api.keypay.com.au/
  */
-import { AU_EMPLOYEE_OPERATIONAL_FIELDS, AU_EMPLOYEE_FIELDS, EMPLOYEE_GROUP_FIELDS, ROSTER_SHIFT_FIELDS, KIOSK_EMPLOYEE_FIELDS, } from './types.js';
+import { AU_EMPLOYEE_OPERATIONAL_FIELDS, AU_EMPLOYEE_FIELDS, LOCATION_FIELDS, EMPLOYEE_GROUP_FIELDS, ROSTER_SHIFT_FIELDS, KIOSK_FIELDS, KIOSK_EMPLOYEE_FIELDS, } from './types.js';
 import { buildBasicAuthHeader, pickFields } from './utils.js';
 import { parseEHErrorResponse } from './errors.js';
 import { EH_API_BASE, EH_REGION_URLS } from './constants.js';
-import { TTLCache, getErrorMessage, fetchWithRetry } from '@markwharton/api-core';
+import { TTLCache, getErrorMessage, fetchWithRetry, ok, err } from '@markwharton/api-core';
 import { RateLimiter } from './rate-limiter.js';
 /** Default page size for paginated endpoints */
 const DEFAULT_PAGE_SIZE = 100;
@@ -28,7 +28,7 @@ const DEFAULT_PAGE_SIZE = 100;
  * await client.validateApiKey();
  *
  * // Get employees
- * const { employees } = await client.getEmployees();
+ * const { data: employees } = await client.getEmployees();
  * ```
  */
 export class EHClient {
@@ -43,9 +43,11 @@ export class EHClient {
         }
         this.cacheTtl = {
             employeesTtl: config.cache?.employeesTtl ?? 300000,
+            locationsTtl: config.cache?.locationsTtl ?? 300000,
             groupsTtl: config.cache?.groupsTtl ?? 300000,
             standardHoursTtl: config.cache?.standardHoursTtl ?? 300000,
             rosterShiftsTtl: config.cache?.rosterShiftsTtl ?? 120000,
+            kiosksTtl: config.cache?.kiosksTtl ?? 300000,
             kioskStaffTtl: config.cache?.kioskStaffTtl ?? 60000,
             reportFieldsTtl: config.cache?.reportFieldsTtl ?? 600000,
         };
@@ -120,12 +122,12 @@ export class EHClient {
             if (!response.ok) {
                 const errorText = await response.text();
                 const { message } = parseEHErrorResponse(errorText, response.status);
-                return { error: { message, statusCode: response.status } };
+                return err(message, response.status);
             }
-            return { data: await parse(response) };
+            return ok(await parse(response));
         }
         catch (error) {
-            return { error: { message: getErrorMessage(error), statusCode: 0 } };
+            return err(getErrorMessage(error), 0);
         }
     }
     // ============================================================================
@@ -139,15 +141,15 @@ export class EHClient {
         try {
             const response = await this.fetch(url);
             if (response.ok) {
-                return { valid: true };
+                return { ok: true };
             }
             if (response.status === 401 || response.status === 403) {
-                return { valid: false, error: 'Invalid or expired API key' };
+                return err('Invalid or expired API key', response.status);
             }
-            return { valid: false, error: `Unexpected response: HTTP ${response.status}` };
+            return err(`Unexpected response: HTTP ${response.status}`, response.status);
         }
         catch (error) {
-            return { valid: false, error: getErrorMessage(error) || 'Connection failed' };
+            return err(getErrorMessage(error) || 'Connection failed');
         }
     }
     // ============================================================================
@@ -183,7 +185,7 @@ export class EHClient {
                     if (!response.ok) {
                         const errorText = await response.text();
                         const { message } = parseEHErrorResponse(errorText, response.status);
-                        return { error: { message, statusCode: response.status } };
+                        return err(message, response.status);
                     }
                     const page = (await response.json())
                         .map(item => pickFields(item, fields));
@@ -192,10 +194,10 @@ export class EHClient {
                         break;
                     skip += DEFAULT_PAGE_SIZE;
                 }
-                return { employees: allEmployees };
+                return ok(allEmployees);
             }
             catch (error) {
-                return { error: { message: getErrorMessage(error), statusCode: 0 } };
+                return err(getErrorMessage(error), 0);
             }
         });
     }
@@ -207,10 +209,9 @@ export class EHClient {
         const cacheKey = options?.includePii ? `employee:${employeeId}:pii` : `employee:${employeeId}`;
         return this.cached(cacheKey, this.cacheTtl.employeesTtl, async () => {
             const url = `${this.baseUrl}/business/${this.businessId}/employee/unstructured/${employeeId}`;
-            const { data, error } = await this.fetchAndParse(url, async (r) => {
+            return this.fetchAndParse(url, async (r) => {
                 return pickFields(await r.json(), fields);
             });
-            return error ? { error } : { employee: data };
         });
     }
     // ============================================================================
@@ -222,10 +223,46 @@ export class EHClient {
     async getStandardHours(employeeId) {
         return this.cached(`standardhours:${employeeId}`, this.cacheTtl.standardHoursTtl, async () => {
             const url = `${this.baseUrl}/business/${this.businessId}/employee/${employeeId}/standardhours`;
-            const { data, error } = await this.fetchAndParse(url, async (r) => {
+            return this.fetchAndParse(url, async (r) => {
                 return await r.json();
             }, { description: `Get standard hours for employee ${employeeId}` });
-            return error ? { error } : { standardHours: data };
+        });
+    }
+    // ============================================================================
+    // Locations
+    // ============================================================================
+    /**
+     * Get all business locations
+     */
+    async getLocations() {
+        return this.cached('locations', this.cacheTtl.locationsTtl, async () => {
+            const params = new URLSearchParams({
+                '$top': String(DEFAULT_PAGE_SIZE),
+            });
+            try {
+                const allLocations = [];
+                let skip = 0;
+                while (true) {
+                    params.set('$skip', String(skip));
+                    const url = `${this.baseUrl}/business/${this.businessId}/location?${params}`;
+                    const response = await this.fetch(url);
+                    if (!response.ok) {
+                        const errorText = await response.text();
+                        const { message } = parseEHErrorResponse(errorText, response.status);
+                        return err(message, response.status);
+                    }
+                    const page = (await response.json())
+                        .map(item => pickFields(item, LOCATION_FIELDS));
+                    allLocations.push(...page);
+                    if (page.length < DEFAULT_PAGE_SIZE)
+                        break;
+                    skip += DEFAULT_PAGE_SIZE;
+                }
+                return ok(allLocations);
+            }
+            catch (error) {
+                return err(getErrorMessage(error), 0);
+            }
         });
     }
     // ============================================================================
@@ -249,7 +286,7 @@ export class EHClient {
                     if (!response.ok) {
                         const errorText = await response.text();
                         const { message } = parseEHErrorResponse(errorText, response.status);
-                        return { error: { message, statusCode: response.status } };
+                        return err(message, response.status);
                     }
                     const page = (await response.json())
                         .map(item => pickFields(item, EMPLOYEE_GROUP_FIELDS));
@@ -258,10 +295,10 @@ export class EHClient {
                         break;
                     skip += DEFAULT_PAGE_SIZE;
                 }
-                return { employeeGroups: allGroups };
+                return ok(allGroups);
             }
             catch (error) {
-                return { error: { message: getErrorMessage(error), statusCode: 0 } };
+                return err(getErrorMessage(error), 0);
             }
         });
     }
@@ -353,7 +390,7 @@ export class EHClient {
                     if (!response.ok) {
                         const errorText = await response.text();
                         const { message } = parseEHErrorResponse(errorText, response.status);
-                        return { error: { message, statusCode: response.status } };
+                        return err(message, response.status);
                     }
                     const page = (await response.json())
                         .map(item => pickFields(item, ROSTER_SHIFT_FIELDS));
@@ -362,16 +399,50 @@ export class EHClient {
                         break;
                     currentPage++;
                 }
-                return { rosterShifts: allShifts };
+                return ok(allShifts);
             }
             catch (error) {
-                return { error: { message: getErrorMessage(error), statusCode: 0 } };
+                return err(getErrorMessage(error), 0);
             }
         });
     }
     // ============================================================================
     // Time & Attendance (Kiosk)
     // ============================================================================
+    /**
+     * Get all kiosks for the business
+     */
+    async getKiosks() {
+        return this.cached('kiosks', this.cacheTtl.kiosksTtl, async () => {
+            const params = new URLSearchParams({
+                '$top': String(DEFAULT_PAGE_SIZE),
+            });
+            try {
+                const allKiosks = [];
+                let skip = 0;
+                while (true) {
+                    params.set('$skip', String(skip));
+                    const url = `${this.baseUrl}/business/${this.businessId}/kiosk?${params}`;
+                    const response = await this.fetch(url);
+                    if (!response.ok) {
+                        const errorText = await response.text();
+                        const { message } = parseEHErrorResponse(errorText, response.status);
+                        return err(message, response.status);
+                    }
+                    const page = (await response.json())
+                        .map(item => pickFields(item, KIOSK_FIELDS));
+                    allKiosks.push(...page);
+                    if (page.length < DEFAULT_PAGE_SIZE)
+                        break;
+                    skip += DEFAULT_PAGE_SIZE;
+                }
+                return ok(allKiosks);
+            }
+            catch (error) {
+                return err(getErrorMessage(error), 0);
+            }
+        });
+    }
     /**
      * Get kiosk staff for time and attendance
      *
@@ -391,11 +462,10 @@ export class EHClient {
             const url = queryString
                 ? `${this.baseUrl}/business/${this.businessId}/kiosk/${kioskId}/staff?${queryString}`
                 : `${this.baseUrl}/business/${this.businessId}/kiosk/${kioskId}/staff`;
-            const { data, error } = await this.fetchAndParse(url, async (r) => {
+            return this.fetchAndParse(url, async (r) => {
                 return (await r.json())
                     .map(item => pickFields(item, KIOSK_EMPLOYEE_FIELDS));
             });
-            return error ? { error } : { staff: data };
         });
     }
     // ============================================================================
@@ -410,10 +480,9 @@ export class EHClient {
     async getReportFields() {
         return this.cached('reportfields', this.cacheTtl.reportFieldsTtl, async () => {
             const url = `${this.baseUrl}/business/${this.businessId}/report/employeedetails/fields`;
-            const { data, error } = await this.fetchAndParse(url, async (r) => {
+            return this.fetchAndParse(url, async (r) => {
                 return await r.json();
             });
-            return error ? { error } : { fields: data };
         });
     }
     /**
@@ -441,9 +510,8 @@ export class EHClient {
         const url = queryString
             ? `${this.baseUrl}/business/${this.businessId}/report/employeedetails?${queryString}`
             : `${this.baseUrl}/business/${this.businessId}/report/employeedetails`;
-        const { data, error } = await this.fetchAndParse(url, async (r) => {
+        return this.fetchAndParse(url, async (r) => {
             return await r.json();
         });
-        return error ? { error } : { records: data };
     }
 }

package/dist/errors.d.ts

@@ -26,10 +26,10 @@ export declare function parseEHErrorResponse(errorText: string, statusCode: numb
  */
 export declare class EHError extends Error {
     /** HTTP status code */
-    statusCode: number;
+    status: number;
     /** Raw error response */
     rawResponse?: string;
-    constructor(message: string, statusCode: number, options?: {
+    constructor(message: string, status: number, options?: {
         rawResponse?: string;
     });
     /**

package/dist/errors.js

@@ -34,10 +34,10 @@ export function parseEHErrorResponse(errorText, statusCode) {
  * Custom error class for EH API errors
  */
 export class EHError extends Error {
-    constructor(message, statusCode, options) {
+    constructor(message, status, options) {
         super(message);
         this.name = 'EHError';
-        this.statusCode = statusCode;
+        this.status = status;
         this.rawResponse = options?.rawResponse;
     }
     /**

package/dist/index.d.ts

@@ -13,19 +13,20 @@
  * await client.validateApiKey();
  *
  * // Get employees
- * const { employees } = await client.getEmployees();
+ * const { data: employees } = await client.getEmployees();
  *
  * // Get roster shifts
- * const { rosterShifts } = await client.getRosterShifts('2026-02-03', '2026-02-09');
+ * const { data: rosterShifts } = await client.getRosterShifts('2026-02-03', '2026-02-09');
  * ```
  */
 export { EHClient } from './client.js';
-export type { EHConfig, EHCacheConfig, EHRetryConfig, EHEmployee, EHEmployeeOptions, EHSingleEmployeeOptions, EHStandardHours, EHEmployeeGroup, EHRosterShift, EHRosterShiftOptions, EHAttendanceStatus, EHKioskEmployee, EHKioskStaffOptions, EHReportField, EHEmployeeDetailsReportOptions, EHErrorInfo, } from './types.js';
-export { AU_EMPLOYEE_OPERATIONAL_FIELDS, AU_EMPLOYEE_PII_FIELDS, AU_EMPLOYEE_FIELDS, EMPLOYEE_GROUP_FIELDS, ROSTER_SHIFT_FIELDS, KIOSK_EMPLOYEE_FIELDS, } from './types.js';
+export type { EHConfig, EHCacheConfig, EHRetryConfig, EHEmployee, EHEmployeeOptions, EHSingleEmployeeOptions, EHStandardHours, EHLocation, EHEmployeeGroup, EHRosterShift, EHRosterShiftOptions, EHAttendanceStatus, EHKiosk, EHKioskEmployee, EHKioskStaffOptions, EHReportField, EHEmployeeDetailsReportOptions, } from './types.js';
+export { AU_EMPLOYEE_OPERATIONAL_FIELDS, AU_EMPLOYEE_PII_FIELDS, AU_EMPLOYEE_FIELDS, LOCATION_FIELDS, EMPLOYEE_GROUP_FIELDS, ROSTER_SHIFT_FIELDS, KIOSK_FIELDS, KIOSK_EMPLOYEE_FIELDS, } from './types.js';
 export type { EHAuEmployee } from './employee-types.generated.js';
 export { RateLimiter } from './rate-limiter.js';
 export { buildBasicAuthHeader, pickFields } from './utils.js';
-export { getErrorMessage } from '@markwharton/api-core';
+export { ok, err, getErrorMessage } from '@markwharton/api-core';
+export type { Result, RetryConfig } from '@markwharton/api-core';
 export { EH_API_BASE, EH_REGION_URLS } from './constants.js';
 export type { EHRegion } from './constants.js';
 export { EHError, parseEHErrorResponse } from './errors.js';

package/dist/index.js

@@ -13,21 +13,22 @@
  * await client.validateApiKey();
  *
  * // Get employees
- * const { employees } = await client.getEmployees();
+ * const { data: employees } = await client.getEmployees();
  *
  * // Get roster shifts
- * const { rosterShifts } = await client.getRosterShifts('2026-02-03', '2026-02-09');
+ * const { data: rosterShifts } = await client.getRosterShifts('2026-02-03', '2026-02-09');
  * ```
  */
 // Main client
 export { EHClient } from './client.js';
 // Field key constants (whitelists for pickFields)
-export { AU_EMPLOYEE_OPERATIONAL_FIELDS, AU_EMPLOYEE_PII_FIELDS, AU_EMPLOYEE_FIELDS, EMPLOYEE_GROUP_FIELDS, ROSTER_SHIFT_FIELDS, KIOSK_EMPLOYEE_FIELDS, } from './types.js';
+export { AU_EMPLOYEE_OPERATIONAL_FIELDS, AU_EMPLOYEE_PII_FIELDS, AU_EMPLOYEE_FIELDS, LOCATION_FIELDS, EMPLOYEE_GROUP_FIELDS, ROSTER_SHIFT_FIELDS, KIOSK_FIELDS, KIOSK_EMPLOYEE_FIELDS, } from './types.js';
 // Rate limiting
 export { RateLimiter } from './rate-limiter.js';
 // Utilities
 export { buildBasicAuthHeader, pickFields } from './utils.js';
-export { getErrorMessage } from '@markwharton/api-core';
+// Result pattern (re-exported from @markwharton/api-core)
+export { ok, err, getErrorMessage } from '@markwharton/api-core';
 // Constants
 export { EH_API_BASE, EH_REGION_URLS } from './constants.js';
 // Errors

package/dist/types.d.ts

@@ -5,6 +5,7 @@
  * Based on the API reference and KeyPay .NET SDK models.
  */
 import type { EHRegion } from './constants.js';
+import type { RetryConfig } from '@markwharton/api-core';
 /**
  * Cache configuration for EHClient
  *
@@ -14,32 +15,23 @@ import type { EHRegion } from './constants.js';
 export interface EHCacheConfig {
     /** TTL for employee list (default: 300000 = 5 min) */
     employeesTtl?: number;
+    /** TTL for locations (default: 300000 = 5 min) */
+    locationsTtl?: number;
     /** TTL for employee groups (default: 300000 = 5 min) */
     groupsTtl?: number;
     /** TTL for standard hours (default: 300000 = 5 min) */
     standardHoursTtl?: number;
     /** TTL for roster shifts (default: 120000 = 2 min) */
     rosterShiftsTtl?: number;
+    /** TTL for kiosks list (default: 300000 = 5 min) */
+    kiosksTtl?: number;
     /** TTL for kiosk staff (default: 60000 = 1 min) */
     kioskStaffTtl?: number;
     /** TTL for report fields (default: 600000 = 10 min) */
     reportFieldsTtl?: number;
 }
-/**
- * Retry configuration for EHClient
- *
- * Controls automatic retry behavior for transient failures
- * (HTTP 429 Too Many Requests, 503 Service Unavailable).
- * Uses exponential backoff with optional Retry-After header support.
- */
-export interface EHRetryConfig {
-    /** Maximum number of retry attempts (default: 3) */
-    maxRetries?: number;
-    /** Initial delay in milliseconds before first retry (default: 1000) */
-    initialDelayMs?: number;
-    /** Maximum delay cap in milliseconds (default: 10000) */
-    maxDelayMs?: number;
-}
+/** @deprecated Use `RetryConfig` from `@markwharton/api-core` directly. */
+export type EHRetryConfig = RetryConfig;
 /**
  * Employment Hero Payroll configuration for API access
  */
@@ -90,6 +82,31 @@ export interface EHStandardHours {
     /** Full-time equivalent hours (the FTE value) */
     fullTimeEquivalentHours: number | null;
 }
+/**
+ * Business location
+ *
+ * From GET /business/{id}/location
+ */
+export interface EHLocation {
+    /** Location ID */
+    id: number;
+    /** Parent location ID (for hierarchy) */
+    parentId: number | null;
+    /** Location name */
+    name: string;
+    /** External identifier */
+    externalId: string | null;
+    /** Source system that created this location */
+    source: string | null;
+    /** Fully qualified name (includes parent hierarchy) */
+    fullyQualifiedName: string | null;
+    /** Whether this is a global/default location */
+    isGlobal: boolean;
+    /** Australian state */
+    state: string | null;
+    /** Country */
+    country: string | null;
+}
 /**
  * Employee group
  */
@@ -212,6 +229,45 @@ export interface EHRosterShiftOptions {
     /** Include warning data in response */
     includeWarnings?: boolean;
 }
+/**
+ * Kiosk configuration
+ *
+ * From GET /business/{id}/kiosk
+ */
+export interface EHKiosk {
+    /** Kiosk ID */
+    id: number;
+    /** External identifier */
+    externalId: string | null;
+    /** Kiosk name */
+    name: string;
+    /** Associated location ID */
+    locationId: number | null;
+    /** Windows timezone name */
+    timeZone: string | null;
+    /** IANA timezone name (read-only) */
+    ianaTimeZone: string | null;
+    /** Allow higher classification selection */
+    allowHigherClassificationSelection: boolean;
+    /** Whether location is required for clock on */
+    isLocationRequired: boolean;
+    /** Whether work type is required for clock on */
+    isWorkTypeRequired: boolean;
+    /** Restrict locations for employees */
+    restrictLocationsForEmployees: boolean;
+    /** Allow employee shift selection */
+    allowEmployeeShiftSelection: boolean | null;
+    /** Clock on window in minutes */
+    clockOnWindowMinutes: number | null;
+    /** Clock off window in minutes */
+    clockOffWindowMinutes: number | null;
+    /** Whether photo is required for clock on */
+    isPhotoRequired: boolean | null;
+    /** Whether kiosk can add employees */
+    canAddEmployees: boolean;
+    /** Whether paid breaks are enabled */
+    paidBreaksEnabled: boolean;
+}
 /**
  * Options for getKioskStaff
  */
@@ -245,15 +301,10 @@ export interface EHEmployeeDetailsReportOptions {
     /** Include inactive employees (default: false) */
     includeInactive?: boolean;
 }
-/**
- * Structured error information from EH API
- */
-export interface EHErrorInfo {
-    /** Human-readable error message */
-    message: string;
-    /** HTTP status code from the response */
-    statusCode: number;
-}
+/** Whitelisted fields for EHLocation */
+export declare const LOCATION_FIELDS: readonly ["id", "parentId", "name", "externalId", "source", "fullyQualifiedName", "isGlobal", "state", "country"];
+/** Whitelisted fields for EHKiosk */
+export declare const KIOSK_FIELDS: readonly ["id", "externalId", "name", "locationId", "timeZone", "ianaTimeZone", "allowHigherClassificationSelection", "isLocationRequired", "isWorkTypeRequired", "restrictLocationsForEmployees", "allowEmployeeShiftSelection", "clockOnWindowMinutes", "clockOffWindowMinutes", "isPhotoRequired", "canAddEmployees", "paidBreaksEnabled"];
 /** Whitelisted fields for EHKioskEmployee */
 export declare const KIOSK_EMPLOYEE_FIELDS: readonly ["employeeId", "firstName", "surname", "name", "status", "clockOnTimeUtc", "breakStartTimeUtc", "currentShiftId", "employeeStartDate", "employeeGroupIds", "longShift", "recordedTimeUtc"];
 /** Whitelisted fields for EHEmployeeGroup */

package/dist/types.js

@@ -7,6 +7,19 @@
 // ============================================================================
 // Field Key Constants (whitelists for pickFields)
 // ============================================================================
+/** Whitelisted fields for EHLocation */
+export const LOCATION_FIELDS = [
+    'id', 'parentId', 'name', 'externalId', 'source',
+    'fullyQualifiedName', 'isGlobal', 'state', 'country',
+];
+/** Whitelisted fields for EHKiosk */
+export const KIOSK_FIELDS = [
+    'id', 'externalId', 'name', 'locationId', 'timeZone', 'ianaTimeZone',
+    'allowHigherClassificationSelection', 'isLocationRequired', 'isWorkTypeRequired',
+    'restrictLocationsForEmployees', 'allowEmployeeShiftSelection',
+    'clockOnWindowMinutes', 'clockOffWindowMinutes',
+    'isPhotoRequired', 'canAddEmployees', 'paidBreaksEnabled',
+];
 /** Whitelisted fields for EHKioskEmployee */
 export const KIOSK_EMPLOYEE_FIELDS = [
     'employeeId', 'firstName', 'surname', 'name', 'status',

package/package.json

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