@markwharton/eh-payroll 3.0.0 → 3.1.0

package/dist/client.js

@@ -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.EHAuEmployee.path, params);
-            }, ENTITIES.EHAuEmployee.fields);
+                return this.businessUrl(ENTITIES.EHEmployee.path, params);
+            }, ENTITIES.EHEmployee.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.EHAuEmployee.path}/${employeeId}`);
+            const url = this.businessUrl(`${ENTITIES.EHEmployee.path}/${employeeId}`);
             return this.fetchAndParse(url, async (r) => {
-                return pickFields(await r.json(), ENTITIES.EHAuEmployee.fields);
+                return pickFields(await r.json(), ENTITIES.EHEmployee.fields);
             });
         }, this.restrictedPersistOpt);
     }

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 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';
+/** AU employee from unstructured endpoint (139 fields) */
+export interface EHEmployee {
     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: EHCloselyHeldReporting | 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: EHLeaveAccrualStartDateType | null;
     leaveTemplate: string | null;
     leaveYearStart: string | null;
     locations: string | null;
+    maximumQuarterlySuperContributionsBase: number | null;
+    medicareLevyExemption: string | null;
+    medicareLevyReductionDependentCount: number | null;
+    medicareLevyReductionSpouse: boolean;
+    medicareLevySurchargeWithholdingTier: EHMedicareLevySurchargeWithholdingTier | 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: EHSingleTouchPayrollCategory | null;
+    startDate: string | null;
+    status: EHEmployeeStatus | 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: EHTaxCategory | 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 {};

package/dist/index.d.ts

@@ -20,7 +20,7 @@
  * ```
  */
 export { EHClient } from './client.js';
-export type { EHConfig, EHCacheConfig, EHRetryConfig, EHLeaveRequest, EHLeaveRequestOptions, EHEmployeeLeaveRequestOptions, EHLeaveRequestStatus, EHEmployee, EHEmployeeOptions, EHStandardHours, EHLocation, EHEmployeeGroup, EHRosterShift, EHRosterShiftOptions, EHAttendanceStatus, EHKiosk, EHKioskEmployee, EHKioskStaffOptions, EHEmployeeImage, } from './types.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 type { AccessTier } from './types.js';
 export { METHOD_TIERS } from './types.js';

package/dist/types.d.ts

@@ -56,7 +56,7 @@ export interface EHConfig extends ClientConfig {
  *
  * @see employee-types.generated.ts
  */
-export type { EHEmployee } from './employee-types.generated.js';
+export type { EHEmployee, EHEmployeeStatus, EHLeaveAccrualStartDateType, EHCloselyHeldReporting, EHMedicareLevySurchargeWithholdingTier, EHSingleTouchPayrollCategory, EHTaxCategory, } from './employee-types.generated.js';
 /**
  * Standard hours for an employee
  *
@@ -217,6 +217,8 @@ export interface EHEmployeeImage {
 }
 /** Leave request status values */
 export type EHLeaveRequestStatus = 'Approved' | 'Pending' | 'Rejected' | 'Cancelled';
+/** Leave request grouping options */
+export type EHLeaveRequestGroupBy = 'Employee' | 'LeaveType';
 /**
  * Options for getLeaveRequests
  *
@@ -236,7 +238,7 @@ export interface EHLeaveRequestOptions {
     /** Filter by location ID (→ API LocationId) */
     locationId?: number;
     /** Group results by 'Employee' or 'LeaveType' (→ API GroupBy) */
-    groupBy?: 'Employee' | 'LeaveType';
+    groupBy?: EHLeaveRequestGroupBy;
     /** Restrict results to leave overlapping the date range (→ API RestrictOverlappingLeave) */
     restrictOverlappingLeave?: boolean;
 }
@@ -262,6 +264,8 @@ export interface EHEmployeeOptions {
     /** Filter by location ID */
     locationId?: number;
 }
+/** Roster shift status filter values */
+export type EHShiftStatus = 'All' | 'Published' | 'Unpublished' | 'Accepted';
 /**
  * Options for getRosterShifts
  */
@@ -275,9 +279,9 @@ export interface EHRosterShiftOptions {
     /** Include shifts with all roles (default: only unassigned roles) */
     selectAllRoles?: boolean;
     /** Filter by single shift status */
-    shiftStatus?: 'All' | 'Published' | 'Unpublished' | 'Accepted';
+    shiftStatus?: EHShiftStatus;
     /** Filter by multiple shift statuses */
-    shiftStatuses?: ('All' | 'Published' | 'Unpublished' | 'Accepted')[];
+    shiftStatuses?: EHShiftStatus[];
     /** Filter by specific locations (multiple) */
     selectedLocations?: string[];
     /** Filter by specific employees (multiple) */

package/dist/types.js

@@ -111,7 +111,7 @@ export const EMPLOYEE_FIELDS = {
 };
 /** Entity registry — maps interface names to field specs and API path segments. */
 export const ENTITIES = {
-    EHAuEmployee: { fields: EMPLOYEE_FIELDS, path: 'employee/unstructured', apiRef: 'employee/au-employee--get-employees', apiRefById: 'employee/au-employee--get-employee-by-id' },
+    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' },

package/package.json

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