@unified-api/typescript-sdk 2.85.48 → 2.85.50

package/src/sdk/models/shared/hrisbankaccount.ts

@@ -18,19 +18,81 @@ export type HrisBankaccountAccountType = OpenEnum<
   typeof HrisBankaccountAccountType
 >;
 
+/**
+ * how net pay is split into this account when an employee has several accounts
+ */
+export const SplitType = {
+  Percentage: "PERCENTAGE",
+  Fixed: "FIXED",
+  Remainder: "REMAINDER",
+} as const;
+/**
+ * how net pay is split into this account when an employee has several accounts
+ */
+export type SplitType = OpenEnum<typeof SplitType>;
+
 export type HrisBankaccount = {
   accountNumber?: string | undefined;
+  /**
+   * when full number not returned
+   */
   accountNumberLast4?: string | undefined;
   accountType?: HrisBankaccountAccountType | undefined;
   bankName?: string | undefined;
+  /**
+   * BIC / SWIFT code
+   */
+  bic?: string | undefined;
+  /**
+   * (reference to HrisCompany)
+   */
   companyId?: string | undefined;
+  /**
+   * ISO 2-digit country code of the bank account
+   */
+  countryCode?: string | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   createdAt?: Date | undefined;
+  currency?: string | undefined;
+  /**
+   * International Bank Account Number (non-US accounts)
+   */
+  iban?: string | undefined;
   id?: string | undefined;
+  /**
+   * primary for direct deposit
+   */
   isPrimary?: boolean | undefined;
+  /**
+   * account nickname (e.g. "BoA Checking")
+   */
   name?: string | undefined;
+  /**
+   * order in which split accounts are funded (1 = first)
+   */
+  priority?: number | undefined;
   raw?: { [k: string]: any } | undefined;
+  /**
+   * 9-digit US routing number
+   */
   routingNumber?: string | undefined;
+  /**
+   * percentage (when split_type is PERCENTAGE) or money (when FIXED)
+   */
+  splitAmount?: number | undefined;
+  /**
+   * how net pay is split into this account when an employee has several accounts
+   */
+  splitType?: SplitType | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   updatedAt?: Date | undefined;
+  /**
+   * employee ID (required for listcreate) (reference to HrisEmployee)
+   */
   userId?: string | undefined;
 };
 
@@ -47,6 +109,19 @@ export const HrisBankaccountAccountType$outboundSchema: z.ZodType<
   HrisBankaccountAccountType
 > = openEnums.outboundSchema(HrisBankaccountAccountType);
 
+/** @internal */
+export const SplitType$inboundSchema: z.ZodType<
+  SplitType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SplitType);
+/** @internal */
+export const SplitType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  SplitType
+> = openEnums.outboundSchema(SplitType);
+
 /** @internal */
 export const HrisBankaccount$inboundSchema: z.ZodType<
   HrisBankaccount,
@@ -57,14 +132,21 @@ export const HrisBankaccount$inboundSchema: z.ZodType<
   account_number_last4: z.string().optional(),
   account_type: HrisBankaccountAccountType$inboundSchema.optional(),
   bank_name: z.string().optional(),
+  bic: z.string().optional(),
   company_id: z.string().optional(),
+  country_code: z.string().optional(),
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
+  currency: z.string().optional(),
+  iban: z.string().optional(),
   id: z.string().optional(),
   is_primary: z.boolean().optional(),
   name: z.string().optional(),
+  priority: z.number().optional(),
   raw: z.record(z.any()).optional(),
   routing_number: z.string().optional(),
+  split_amount: z.number().optional(),
+  split_type: SplitType$inboundSchema.optional(),
   updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   user_id: z.string().optional(),
@@ -75,9 +157,12 @@ export const HrisBankaccount$inboundSchema: z.ZodType<
     "account_type": "accountType",
     "bank_name": "bankName",
     "company_id": "companyId",
+    "country_code": "countryCode",
     "created_at": "createdAt",
     "is_primary": "isPrimary",
     "routing_number": "routingNumber",
+    "split_amount": "splitAmount",
+    "split_type": "splitType",
     "updated_at": "updatedAt",
     "user_id": "userId",
   });
@@ -88,13 +173,20 @@ export type HrisBankaccount$Outbound = {
   account_number_last4?: string | undefined;
   account_type?: string | undefined;
   bank_name?: string | undefined;
+  bic?: string | undefined;
   company_id?: string | undefined;
+  country_code?: string | undefined;
   created_at?: string | undefined;
+  currency?: string | undefined;
+  iban?: string | undefined;
   id?: string | undefined;
   is_primary?: boolean | undefined;
   name?: string | undefined;
+  priority?: number | undefined;
   raw?: { [k: string]: any } | undefined;
   routing_number?: string | undefined;
+  split_amount?: number | undefined;
+  split_type?: string | undefined;
   updated_at?: string | undefined;
   user_id?: string | undefined;
 };
@@ -109,13 +201,20 @@ export const HrisBankaccount$outboundSchema: z.ZodType<
   accountNumberLast4: z.string().optional(),
   accountType: HrisBankaccountAccountType$outboundSchema.optional(),
   bankName: z.string().optional(),
+  bic: z.string().optional(),
   companyId: z.string().optional(),
+  countryCode: z.string().optional(),
   createdAt: z.date().transform(v => v.toISOString()).optional(),
+  currency: z.string().optional(),
+  iban: z.string().optional(),
   id: z.string().optional(),
   isPrimary: z.boolean().optional(),
   name: z.string().optional(),
+  priority: z.number().optional(),
   raw: z.record(z.any()).optional(),
   routingNumber: z.string().optional(),
+  splitAmount: z.number().optional(),
+  splitType: SplitType$outboundSchema.optional(),
   updatedAt: z.date().transform(v => v.toISOString()).optional(),
   userId: z.string().optional(),
 }).transform((v) => {
@@ -125,9 +224,12 @@ export const HrisBankaccount$outboundSchema: z.ZodType<
     accountType: "account_type",
     bankName: "bank_name",
     companyId: "company_id",
+    countryCode: "country_code",
     createdAt: "created_at",
     isPrimary: "is_primary",
     routingNumber: "routing_number",
+    splitAmount: "split_amount",
+    splitType: "split_type",
     updatedAt: "updated_at",
     userId: "user_id",
   });

package/src/sdk/models/shared/hrisbenefit.ts

@@ -29,6 +29,9 @@ export type EmployerContributionType = OpenEnum<
   typeof EmployerContributionType
 >;
 
+/**
+ * Frequency that costs accrue for this benefit. For insurance/benefits, usually "MONTHLY". For compensation, matches pay cycle (WEEKLY, BIWEEKLY, etc).
+ */
 export const HrisBenefitFrequency = {
   OneTime: "ONE_TIME",
   Day: "DAY",
@@ -37,9 +40,17 @@ export const HrisBenefitFrequency = {
   Hour: "HOUR",
   Month: "MONTH",
   Week: "WEEK",
+  Biweekly: "BIWEEKLY",
+  Semimonthly: "SEMIMONTHLY",
 } as const;
+/**
+ * Frequency that costs accrue for this benefit. For insurance/benefits, usually "MONTHLY". For compensation, matches pay cycle (WEEKLY, BIWEEKLY, etc).
+ */
 export type HrisBenefitFrequency = OpenEnum<typeof HrisBenefitFrequency>;
 
+/**
+ * Tax describes the tax treatment of the benefit
+ */
 export const Tax = {
   PreTax: "PRE_TAX",
   PostTax: "POST_TAX",
@@ -47,6 +58,9 @@ export const Tax = {
   NonTaxable: "NON_TAXABLE",
   Tax: "TAX",
 } as const;
+/**
+ * Tax describes the tax treatment of the benefit
+ */
 export type Tax = OpenEnum<typeof Tax>;
 
 export const HrisBenefitType = {
@@ -66,6 +80,10 @@ export const HrisBenefitType = {
   LoanRepayment: "LOAN_REPAYMENT",
   CharitableContribution: "CHARITABLE_CONTRIBUTION",
   Other: "OTHER",
+  RetirementRoth: "RETIREMENT_ROTH",
+  Commuter: "COMMUTER",
+  DependentCare: "DEPENDENT_CARE",
+  Pension: "PENSION",
 } as const;
 export type HrisBenefitType = OpenEnum<typeof HrisBenefitType>;
 
@@ -73,21 +91,48 @@ export type HrisBenefitType = OpenEnum<typeof HrisBenefitType>;
  * Company-wide benefit plans available to employees.
  */
 export type HrisBenefit = {
+  /**
+   * (reference to HrisCompany)
+   */
   companyId?: string | undefined;
   coverageLevel?: CoverageLevel | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   createdAt?: Date | undefined;
   currency?: string | undefined;
+  /**
+   * e.g. "Company 401(k) retirement plan"
+   */
   description?: string | undefined;
+  /**
+   * percentage or money
+   */
   employerContributionAmount?: number | undefined;
+  /**
+   * always money
+   */
   employerContributionMaxAmount?: number | undefined;
   employerContributionType?: EmployerContributionType | undefined;
+  /**
+   * Frequency that costs accrue for this benefit. For insurance/benefits, usually "MONTHLY". For compensation, matches pay cycle (WEEKLY, BIWEEKLY, etc).
+   */
   frequency?: HrisBenefitFrequency | undefined;
   id?: string | undefined;
   isActive?: boolean | undefined;
+  /**
+   * e.g. "401(k) Plan"
+   */
   name?: string | undefined;
   raw?: { [k: string]: any } | undefined;
+  /**
+   * Tax describes the tax treatment of the benefit
+   */
   tax?: Tax | undefined;
   type?: HrisBenefitType | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   updatedAt?: Date | undefined;
 };
 

package/src/sdk/models/shared/hriscompany.ts

@@ -16,11 +16,17 @@ import {
 
 export type HrisCompany = {
   address?: PropertyHrisCompanyAddress | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   createdAt?: Date | undefined;
   id?: string | undefined;
   legalName?: string | undefined;
   name?: string | undefined;
   raw?: { [k: string]: any } | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   updatedAt?: Date | undefined;
 };
 

package/src/sdk/models/shared/hriscompensation.ts

@@ -18,6 +18,8 @@ export const HrisCompensationFrequency = {
   Hour: "HOUR",
   Month: "MONTH",
   Week: "WEEK",
+  Biweekly: "BIWEEKLY",
+  Semimonthly: "SEMIMONTHLY",
 } as const;
 export type HrisCompensationFrequency = OpenEnum<
   typeof HrisCompensationFrequency
@@ -29,6 +31,8 @@ export const HrisCompensationType = {
   StockOptions: "STOCK_OPTIONS",
   Equity: "EQUITY",
   Other: "OTHER",
+  Hourly: "HOURLY",
+  Commission: "COMMISSION",
 } as const;
 export type HrisCompensationType = OpenEnum<typeof HrisCompensationType>;
 
@@ -36,6 +40,9 @@ export type HrisCompensation = {
   amount?: number | undefined;
   currency?: string | undefined;
   frequency?: HrisCompensationFrequency | undefined;
+  /**
+   * (reference to HrisGroup)
+   */
   groupId?: string | undefined;
   notes?: string | undefined;
   type?: HrisCompensationType | undefined;

package/src/sdk/models/shared/hrisdeduction.ts

@@ -10,6 +10,9 @@ import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Level selected by employee (e.g. "FAMILY", "EMPLOYEE_ONLY", or other)
+ */
 export const HrisDeductionCoverageLevel = {
   EmployeeOnly: "EMPLOYEE_ONLY",
   EmployeeSpouse: "EMPLOYEE_SPOUSE",
@@ -19,10 +22,22 @@ export const HrisDeductionCoverageLevel = {
   Family: "FAMILY",
   Other: "OTHER",
 } as const;
+/**
+ * Level selected by employee (e.g. "FAMILY", "EMPLOYEE_ONLY", or other)
+ */
 export type HrisDeductionCoverageLevel = OpenEnum<
   typeof HrisDeductionCoverageLevel
 >;
 
+export const EmployerType = {
+  Percentage: "PERCENTAGE",
+  Fixed: "FIXED",
+} as const;
+export type EmployerType = OpenEnum<typeof EmployerType>;
+
+/**
+ * Frequency for this deduction (should always be set, matches IHrisBenefit.frequency)
+ */
 export const HrisDeductionFrequency = {
   OneTime: "ONE_TIME",
   Day: "DAY",
@@ -31,9 +46,30 @@ export const HrisDeductionFrequency = {
   Hour: "HOUR",
   Month: "MONTH",
   Week: "WEEK",
+  Biweekly: "BIWEEKLY",
+  Semimonthly: "SEMIMONTHLY",
 } as const;
+/**
+ * Frequency for this deduction (should always be set, matches IHrisBenefit.frequency)
+ */
 export type HrisDeductionFrequency = OpenEnum<typeof HrisDeductionFrequency>;
 
+/**
+ * set when this deduction is a court-ordered garnishment
+ */
+export const GarnishmentType = {
+  ChildSupport: "CHILD_SUPPORT",
+  TaxLevy: "TAX_LEVY",
+  StudentLoan: "STUDENT_LOAN",
+  Creditor: "CREDITOR",
+  Bankruptcy: "BANKRUPTCY",
+  Other: "OTHER",
+} as const;
+/**
+ * set when this deduction is a court-ordered garnishment
+ */
+export type GarnishmentType = OpenEnum<typeof GarnishmentType>;
+
 export const HrisDeductionType = {
   Fixed: "FIXED",
   Percentage: "PERCENTAGE",
@@ -44,20 +80,64 @@ export type HrisDeductionType = OpenEnum<typeof HrisDeductionType>;
  * Employee-specific deduction/benefit enrolment.
  */
 export type HrisDeduction = {
+  /**
+   * percentage or absolute amount (employee's portion)
+   */
   amount?: number | undefined;
   benefitId?: string | undefined;
+  /**
+   * (reference to HrisCompany)
+   */
   companyId?: string | undefined;
+  /**
+   * Level selected by employee (e.g. "FAMILY", "EMPLOYEE_ONLY", or other)
+   */
   coverageLevel?: HrisDeductionCoverageLevel | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   createdAt?: Date | undefined;
+  /**
+   * percentage or absolute amount (employer's portion/match)
+   */
+  employerAmount?: number | undefined;
+  employerType?: EmployerType | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   endAt?: Date | undefined;
+  /**
+   * Frequency for this deduction (should always be set, matches IHrisBenefit.frequency)
+   */
   frequency?: HrisDeductionFrequency | undefined;
+  /**
+   * set when this deduction is a court-ordered garnishment
+   */
+  garnishmentType?: GarnishmentType | undefined;
   id?: string | undefined;
   isActive?: boolean | undefined;
+  /**
+   * annual maximum employee amount (always money)
+   */
+  maxAmount?: number | undefined;
   notes?: string | undefined;
+  /**
+   * the hris_paycode (deduction code) this deduction uses
+   */
+  paycodeId?: string | undefined;
   raw?: { [k: string]: any } | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   startAt?: Date | undefined;
   type?: HrisDeductionType | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   updatedAt?: Date | undefined;
+  /**
+   * employee ID (reference to HrisEmployee)
+   */
   userId?: string | undefined;
 };
 
@@ -74,6 +154,19 @@ export const HrisDeductionCoverageLevel$outboundSchema: z.ZodType<
   HrisDeductionCoverageLevel
 > = openEnums.outboundSchema(HrisDeductionCoverageLevel);
 
+/** @internal */
+export const EmployerType$inboundSchema: z.ZodType<
+  EmployerType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(EmployerType);
+/** @internal */
+export const EmployerType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  EmployerType
+> = openEnums.outboundSchema(EmployerType);
+
 /** @internal */
 export const HrisDeductionFrequency$inboundSchema: z.ZodType<
   HrisDeductionFrequency,
@@ -87,6 +180,19 @@ export const HrisDeductionFrequency$outboundSchema: z.ZodType<
   HrisDeductionFrequency
 > = openEnums.outboundSchema(HrisDeductionFrequency);
 
+/** @internal */
+export const GarnishmentType$inboundSchema: z.ZodType<
+  GarnishmentType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GarnishmentType);
+/** @internal */
+export const GarnishmentType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  GarnishmentType
+> = openEnums.outboundSchema(GarnishmentType);
+
 /** @internal */
 export const HrisDeductionType$inboundSchema: z.ZodType<
   HrisDeductionType,
@@ -112,12 +218,17 @@ export const HrisDeduction$inboundSchema: z.ZodType<
   coverage_level: HrisDeductionCoverageLevel$inboundSchema.optional(),
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
+  employer_amount: z.number().optional(),
+  employer_type: EmployerType$inboundSchema.optional(),
   end_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   frequency: HrisDeductionFrequency$inboundSchema.optional(),
+  garnishment_type: GarnishmentType$inboundSchema.optional(),
   id: z.string().optional(),
   is_active: z.boolean().optional(),
+  max_amount: z.number().optional(),
   notes: z.string().optional(),
+  paycode_id: z.string().optional(),
   raw: z.record(z.any()).optional(),
   start_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
@@ -131,8 +242,13 @@ export const HrisDeduction$inboundSchema: z.ZodType<
     "company_id": "companyId",
     "coverage_level": "coverageLevel",
     "created_at": "createdAt",
+    "employer_amount": "employerAmount",
+    "employer_type": "employerType",
     "end_at": "endAt",
+    "garnishment_type": "garnishmentType",
     "is_active": "isActive",
+    "max_amount": "maxAmount",
+    "paycode_id": "paycodeId",
     "start_at": "startAt",
     "updated_at": "updatedAt",
     "user_id": "userId",
@@ -145,11 +261,16 @@ export type HrisDeduction$Outbound = {
   company_id?: string | undefined;
   coverage_level?: string | undefined;
   created_at?: string | undefined;
+  employer_amount?: number | undefined;
+  employer_type?: string | undefined;
   end_at?: string | undefined;
   frequency?: string | undefined;
+  garnishment_type?: string | undefined;
   id?: string | undefined;
   is_active?: boolean | undefined;
+  max_amount?: number | undefined;
   notes?: string | undefined;
+  paycode_id?: string | undefined;
   raw?: { [k: string]: any } | undefined;
   start_at?: string | undefined;
   type?: string | undefined;
@@ -168,11 +289,16 @@ export const HrisDeduction$outboundSchema: z.ZodType<
   companyId: z.string().optional(),
   coverageLevel: HrisDeductionCoverageLevel$outboundSchema.optional(),
   createdAt: z.date().transform(v => v.toISOString()).optional(),
+  employerAmount: z.number().optional(),
+  employerType: EmployerType$outboundSchema.optional(),
   endAt: z.date().transform(v => v.toISOString()).optional(),
   frequency: HrisDeductionFrequency$outboundSchema.optional(),
+  garnishmentType: GarnishmentType$outboundSchema.optional(),
   id: z.string().optional(),
   isActive: z.boolean().optional(),
+  maxAmount: z.number().optional(),
   notes: z.string().optional(),
+  paycodeId: z.string().optional(),
   raw: z.record(z.any()).optional(),
   startAt: z.date().transform(v => v.toISOString()).optional(),
   type: HrisDeductionType$outboundSchema.optional(),
@@ -184,8 +310,13 @@ export const HrisDeduction$outboundSchema: z.ZodType<
     companyId: "company_id",
     coverageLevel: "coverage_level",
     createdAt: "created_at",
+    employerAmount: "employer_amount",
+    employerType: "employer_type",
     endAt: "end_at",
+    garnishmentType: "garnishment_type",
     isActive: "is_active",
+    maxAmount: "max_amount",
+    paycodeId: "paycode_id",
     startAt: "start_at",
     updatedAt: "updated_at",
     userId: "user_id",

package/src/sdk/models/shared/hrisdevice.ts

@@ -11,6 +11,9 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 export type HrisDevice = {
   adminUserIds?: Array<string> | undefined;
   assetTag?: string | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   createdAt?: Date | undefined;
   hasAntivirus?: boolean | undefined;
   hasFirewall?: boolean | undefined;
@@ -19,18 +22,36 @@ export type HrisDevice = {
   hasScreenlock?: boolean | undefined;
   id?: string | undefined;
   isMissing?: boolean | undefined;
+  /**
+   * pointer to HR Location object (reference to HrisLocation)
+   */
   locationId?: string | undefined;
+  /**
+   * device manufacturer
+   */
   manufacturer?: string | undefined;
+  /**
+   * device model
+   */
   model?: string | undefined;
   name?: string | undefined;
+  /**
+   * operating system name
+   */
   os?: string | undefined;
   osVersion?: string | undefined;
   raw?: { [k: string]: any } | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   updatedAt?: Date | undefined;
   /**
    * users who have this device
    */
   userIds?: Array<string> | undefined;
+  /**
+   * device version
+   */
   version?: string | undefined;
 };
 

package/src/sdk/models/shared/hrisdocument.ts

@@ -10,6 +10,9 @@ import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * unified, normalized document type (OTHER when unmappable)
+ */
 export const HrisDocumentType = {
   Contract: "CONTRACT",
   OfferLetter: "OFFER_LETTER",
@@ -26,18 +29,42 @@ export const HrisDocumentType = {
   Medical: "MEDICAL",
   Other: "OTHER",
 } as const;
+/**
+ * unified, normalized document type (OTHER when unmappable)
+ */
 export type HrisDocumentType = OpenEnum<typeof HrisDocumentType>;
 
 export type HrisDocument = {
+  /**
+   * (reference to HrisCompany)
+   */
   companyId?: string | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   createdAt?: Date | undefined;
+  /**
+   * base64 encoded file contents for create/update
+   */
   documentData?: string | undefined;
+  /**
+   * download link, expires after 1 hour
+   */
   documentUrl?: string | undefined;
   filename?: string | undefined;
   id?: string | undefined;
   raw?: { [k: string]: any } | undefined;
+  /**
+   * unified, normalized document type (OTHER when unmappable)
+   */
   type?: HrisDocumentType | undefined;
+  /**
+   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   */
   updatedAt?: Date | undefined;
+  /**
+   * pointer to the HR Employee object that owns this document (reference to HrisEmployee)
+   */
   userId?: string | undefined;
 };