import * as z from "zod/v3"; import { ClosedEnum } from "../../types/enums.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import { RFCDate } from "../../types/rfcdate.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; /** * A single tier of a tiered matching scheme. */ export type Tiers = { /** * The percentage of employee deduction within this tier the company contribution will match. */ rate?: string | undefined; /** * Specifies the upper limit (inclusive) percentage of the employee contribution that this tier applies to. * * @remarks * * Use threshold to define each tier's end point, with tiers applied cumulatively from 0% upwards. * * For example: * * If the first tier has a threshold of "3", and `rate` of "100", the company will match 100% of employee contributions from 0% up to and including 3% of payroll. * * If the next tier has a threshold of "5" and a rate of "50", the company will match 50% of contributions from above 3% up to and including 5% of payroll. */ threshold?: string | undefined; /** * The step up difference between this tier's threshold and the previous tier's threshold. In the first tier, this is equivalent to threshold. */ thresholdDelta?: string | undefined; }; export type Two = { tiers?: Array | undefined; }; /** * For the `amount` and `percentage` contribution types, the value of the corresponding amount or percentage. * * @remarks * * For the `tiered` contribution type, an array of tiers. */ export type EmployeeBenefitValue = string | Two; /** * An object representing the type and value of the company contribution. */ export type Contribution = { /** * The company contribution scheme. * * @remarks * * "amount": The company contributes a fixed amount per payroll. If elective is true, the contribution is matching, dollar-for-dollar. * * "percentage": The company contributes a percentage of the payroll amount per payroll period. If elective is true, the contribution is matching, dollar-for-dollar. * * "tiered": The company contribution varies according to the size of the employee deduction. */ type?: string | undefined; /** * For the `amount` and `percentage` contribution types, the value of the corresponding amount or percentage. * * @remarks * * For the `tiered` contribution type, an array of tiers. */ value?: string | Two | undefined; }; export declare const DeductionReducesTaxableIncome: { readonly Unset: "unset"; readonly ReducesTaxableIncome: "reduces_taxable_income"; readonly DoesNotReduceTaxableIncome: "does_not_reduce_taxable_income"; }; export type DeductionReducesTaxableIncome = ClosedEnum; /** * The representation of an employee benefit. */ export type EmployeeBenefit = { /** * The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field. */ version?: string | undefined; /** * Whether the employee benefit is active. */ active: boolean; /** * The amount to be deducted, per pay period, from the employee's pay. */ employeeDeduction: string; /** * Whether the employee deduction amount should be treated as a percentage to be deducted from each payroll. */ deductAsPercentage: boolean; /** * The maximum employee deduction amount per year. A null value signifies no limit. */ employeeDeductionAnnualMaximum?: string | null | undefined; /** * An object representing the type and value of the company contribution. */ contribution?: Contribution | undefined; /** * Whether the company contribution is elective (aka matching). For "tiered" contribution types, this is always true. */ elective: boolean; /** * The maximum company contribution amount per year. A null value signifies no limit. */ companyContributionAnnualMaximum?: string | null | undefined; /** * Some benefits require additional information to determine their limit. * * @remarks * * `Family` and `Individual` are applicable to HSA benefit. * * `Joint Filing or Single` and `Married and Filing Separately` are applicable to Dependent Care FSA benefit. */ limitOption?: string | null | undefined; /** * Whether the employee should use a benefit's "catch up" rate. Only Roth 401k and 401k benefits use this value for employees over 50. */ catchUp: boolean | null; /** * Identifier for a 401(k) loan assigned by the 401(k) provider */ retirementLoanIdentifier?: string | null | undefined; /** * The amount that the employee is insured for. Note: company contribution cannot be present if coverage amount is set. */ coverageAmount?: string | null | undefined; /** * Whether the employee deduction reduces taxable income or not. Only valid for Group Term Life benefits. Note: when the value is not "unset", coverage amount and coverage salary multiplier are ignored. */ deductionReducesTaxableIncome?: DeductionReducesTaxableIncome | null | undefined; /** * The coverage amount as a multiple of the employee's salary. Only applicable for Group Term Life benefits. Note: cannot be set if coverage amount is also set. */ coverageSalaryMultiplier: string | null; /** * The amount to be paid, per pay period, by the company. This field will not appear for tiered contribution types. * * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. */ companyContribution: string; /** * Whether the company_contribution value should be treated as a percentage to be added to each payroll. This field will not appear for tiered contribution types. * * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. */ contributeAsPercentage: boolean; /** * The date the employee benefit will start. */ effectiveDate?: RFCDate | undefined; /** * The date the employee benefit will expire. A null value indicates the benefit will not expire. */ expirationDate?: RFCDate | null | undefined; /** * The UUID of the employee to which the benefit belongs. */ employeeUuid?: string | undefined; /** * The UUID of the company benefit. */ companyBenefitUuid?: string | undefined; /** * The UUID of the employee benefit. */ uuid: string; additionalProperties?: { [k: string]: any; } | undefined; }; /** @internal */ export declare const Tiers$inboundSchema: z.ZodType; export declare function tiersFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const Two$inboundSchema: z.ZodType; export declare function twoFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const EmployeeBenefitValue$inboundSchema: z.ZodType; export declare function employeeBenefitValueFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const Contribution$inboundSchema: z.ZodType; export declare function contributionFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const DeductionReducesTaxableIncome$inboundSchema: z.ZodNativeEnum; /** @internal */ export declare const EmployeeBenefit$inboundSchema: z.ZodType; export declare function employeeBenefitFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=employeebenefit.d.ts.map