import * as z from "zod/v3"; import { ClosedEnum } from "../../types/enums.js"; /** * The employee's compensation payment method. Invalid values will be ignored. */ export declare const PayrollUpdatePaymentMethod: { readonly DirectDeposit: "Direct Deposit"; readonly Check: "Check"; }; /** * The employee's compensation payment method. Invalid values will be ignored. */ export type PayrollUpdatePaymentMethod = ClosedEnum; /** * An array of fixed compensations for the employee. Fixed compensations include tips, bonuses, and one time reimbursements. */ export type PayrollUpdateFixedCompensations = { /** * The name of the compensation. This also serves as the unique, immutable identifier for this compensation. */ name?: string | undefined; /** * The amount of the compensation for the pay period. */ amount?: string | undefined; /** * The UUID of the job for the compensation. */ jobUuid?: string | undefined; }; /** * An array of hourly compensations for the employee. Hourly compensations include regular, overtime, and double overtime hours. */ export type PayrollUpdateHourlyCompensations = { /** * The name of the compensation. This also serves as the unique, immutable identifier for this compensation. */ name?: string | undefined; /** * The number of hours to be compensated for this pay period. */ hours?: string | undefined; /** * The UUIDs of the job for the compensation. */ jobUuid?: string | undefined; }; /** * The amount type of the deduction for the pay period. */ export declare const PayrollUpdateAmountType: { readonly Fixed: "fixed"; readonly Percent: "percent"; }; /** * The amount type of the deduction for the pay period. */ export type PayrollUpdateAmountType = ClosedEnum; /** * An array of deductions for the employee. */ export type PayrollUpdateDeductions = { /** * The name of the deduction. */ name?: string | undefined; /** * The amount of the deduction for the pay period. */ amount?: number | undefined; /** * The amount type of the deduction for the pay period. */ amountType?: PayrollUpdateAmountType | undefined; /** * The UUID of the deduction. This parameter is optional and can be provided in order to update an existing deduction. */ uuid?: string | undefined; }; /** * Override mode. Only `one_time` is currently supported. */ export declare const PayrollUpdateOverrideType: { readonly OneTime: "one_time"; }; /** * Override mode. Only `one_time` is currently supported. */ export type PayrollUpdateOverrideType = ClosedEnum; /** * How to interpret the amount. */ export declare const PayrollUpdateEmployeeCompensationsAmountType: { readonly Fixed: "fixed"; readonly Percent: "percent"; }; /** * How to interpret the amount. */ export type PayrollUpdateEmployeeCompensationsAmountType = ClosedEnum; /** * Federal one-time custom withholding override. */ export type PayrollUpdateFederal = { /** * Override mode. Only `one_time` is currently supported. */ overrideType?: PayrollUpdateOverrideType | undefined; /** * The amount to be withheld for this payroll. */ amount?: string | undefined; /** * How to interpret the amount. */ amountType?: PayrollUpdateEmployeeCompensationsAmountType | undefined; }; /** * Override mode. Only `one_time` is currently supported. */ export declare const PayrollUpdateEmployeeCompensationsOverrideType: { readonly OneTime: "one_time"; }; /** * Override mode. Only `one_time` is currently supported. */ export type PayrollUpdateEmployeeCompensationsOverrideType = ClosedEnum; /** * How to interpret the amount. */ export declare const PayrollUpdateEmployeeCompensationsCustomWithholdingsAmountType: { readonly Fixed: "fixed"; readonly Percent: "percent"; }; /** * How to interpret the amount. */ export type PayrollUpdateEmployeeCompensationsCustomWithholdingsAmountType = ClosedEnum; export type PayrollUpdateState = { /** * The UUID of the EmployeeStateField this withholding applies to. */ employeeStateFieldUuid?: string | undefined; /** * Override mode. Only `one_time` is currently supported. */ overrideType?: PayrollUpdateEmployeeCompensationsOverrideType | undefined; /** * The amount to be withheld for this payroll. */ amount?: string | undefined; /** * How to interpret the amount. */ amountType?: PayrollUpdateEmployeeCompensationsCustomWithholdingsAmountType | undefined; }; /** * Optional per-payroll one-time custom withholdings for federal and/or state income tax. * * @remarks * When provided, the supplied override takes precedence over any persistent withholding schedule for this run. * This field is in limited release; if your application does not have access, requests including it are silently ignored. */ export type PayrollUpdateCustomWithholdings = { /** * Federal one-time custom withholding override. */ federal?: PayrollUpdateFederal | undefined; /** * State one-time custom withholding overrides, one entry per state field. */ state?: Array | undefined; }; export type PayrollUpdatePaidTimeOff = { /** * The name of the PTO. This also serves as the unique, immutable identifier for the PTO. Must pass in name or policy_uuid but not both. */ name?: string | undefined; /** * The hours of this PTO taken during the pay period. */ hours?: string | undefined; /** * The uuid of the PTO policy. Must pass in name or policy_uuid but not both. */ policyUuid?: string | undefined; /** * The outstanding hours paid upon termination. This field is only applicable for termination payrolls. */ finalPayoutUnusedHoursInput?: string | null | undefined; }; export type PayrollUpdateReimbursements = { /** * The dollar amount of the reimbursement for the pay period. */ amount?: string | undefined; /** * The description of the reimbursement. If not provided, the reimbursement will be unnamed. */ description?: string | undefined; /** * The UUID of an existing reimbursement. This parameter is optional and can be provided in order to update an existing reimbursement. */ uuid?: string | undefined; }; export type PayrollUpdateEmployeeCompensations = { /** * The UUID of the employee. */ employeeUuid?: string | undefined; /** * The current version of this employee compensation from the prepared payroll. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field. */ version?: string | undefined; /** * This employee will be excluded from payroll calculation and will not be paid for the payroll. */ excluded?: boolean | undefined; /** * The employee's compensation payment method. Invalid values will be ignored. */ paymentMethod?: PayrollUpdatePaymentMethod | undefined; /** * Custom text that will be printed as a personal note to the employee on a paystub. */ memo?: string | undefined; fixedCompensations?: Array | undefined; hourlyCompensations?: Array | undefined; deductions?: Array | undefined; /** * Optional per-payroll one-time custom withholdings for federal and/or state income tax. * * @remarks * When provided, the supplied override takes precedence over any persistent withholding schedule for this run. * This field is in limited release; if your application does not have access, requests including it are silently ignored. */ customWithholdings?: PayrollUpdateCustomWithholdings | undefined; /** * An array of all paid time off the employee is eligible for this pay period. Each paid time off object can be the name or the specific policy_uuid. */ paidTimeOff?: Array | undefined; /** * An array of reimbursements for the employee. */ reimbursements?: Array | undefined; }; /** * The payment schedule tax rate the payroll is based on. Only relevant for off-cycle payrolls. */ export declare const WithholdingPayPeriod: { readonly EveryWeek: "Every week"; readonly EveryOtherWeek: "Every other week"; readonly TwicePerMonth: "Twice per month"; readonly Monthly: "Monthly"; readonly Quarterly: "Quarterly"; readonly Semiannually: "Semiannually"; readonly Annually: "Annually"; }; /** * The payment schedule tax rate the payroll is based on. Only relevant for off-cycle payrolls. */ export type WithholdingPayPeriod = ClosedEnum; export type PayrollUpdate = { employeeCompensations: Array; /** * The payment schedule tax rate the payroll is based on. Only relevant for off-cycle payrolls. */ withholdingPayPeriod?: WithholdingPayPeriod | undefined; /** * Block regular deductions and contributions for this payroll. Only relevant for off-cycle payrolls. */ skipRegularDeductions?: boolean | undefined; /** * Enable taxes to be withheld at the IRS's required rate of 22% for federal income taxes. State income taxes will be taxed at the state's supplemental tax rate. Otherwise, we'll sum the entirety of the employee's wages and withhold taxes on the entire amount at the rate for regular wages. Only relevant for off-cycle payrolls. */ fixedWithholdingRate?: boolean | undefined; }; /** @internal */ export declare const PayrollUpdatePaymentMethod$outboundSchema: z.ZodNativeEnum; /** @internal */ export type PayrollUpdateFixedCompensations$Outbound = { name?: string | undefined; amount?: string | undefined; job_uuid?: string | undefined; }; /** @internal */ export declare const PayrollUpdateFixedCompensations$outboundSchema: z.ZodType; export declare function payrollUpdateFixedCompensationsToJSON(payrollUpdateFixedCompensations: PayrollUpdateFixedCompensations): string; /** @internal */ export type PayrollUpdateHourlyCompensations$Outbound = { name?: string | undefined; hours?: string | undefined; job_uuid?: string | undefined; }; /** @internal */ export declare const PayrollUpdateHourlyCompensations$outboundSchema: z.ZodType; export declare function payrollUpdateHourlyCompensationsToJSON(payrollUpdateHourlyCompensations: PayrollUpdateHourlyCompensations): string; /** @internal */ export declare const PayrollUpdateAmountType$outboundSchema: z.ZodNativeEnum; /** @internal */ export type PayrollUpdateDeductions$Outbound = { name?: string | undefined; amount?: number | undefined; amount_type?: string | undefined; uuid?: string | undefined; }; /** @internal */ export declare const PayrollUpdateDeductions$outboundSchema: z.ZodType; export declare function payrollUpdateDeductionsToJSON(payrollUpdateDeductions: PayrollUpdateDeductions): string; /** @internal */ export declare const PayrollUpdateOverrideType$outboundSchema: z.ZodNativeEnum; /** @internal */ export declare const PayrollUpdateEmployeeCompensationsAmountType$outboundSchema: z.ZodNativeEnum; /** @internal */ export type PayrollUpdateFederal$Outbound = { override_type?: string | undefined; amount?: string | undefined; amount_type?: string | undefined; }; /** @internal */ export declare const PayrollUpdateFederal$outboundSchema: z.ZodType; export declare function payrollUpdateFederalToJSON(payrollUpdateFederal: PayrollUpdateFederal): string; /** @internal */ export declare const PayrollUpdateEmployeeCompensationsOverrideType$outboundSchema: z.ZodNativeEnum; /** @internal */ export declare const PayrollUpdateEmployeeCompensationsCustomWithholdingsAmountType$outboundSchema: z.ZodNativeEnum; /** @internal */ export type PayrollUpdateState$Outbound = { employee_state_field_uuid?: string | undefined; override_type?: string | undefined; amount?: string | undefined; amount_type?: string | undefined; }; /** @internal */ export declare const PayrollUpdateState$outboundSchema: z.ZodType; export declare function payrollUpdateStateToJSON(payrollUpdateState: PayrollUpdateState): string; /** @internal */ export type PayrollUpdateCustomWithholdings$Outbound = { federal?: PayrollUpdateFederal$Outbound | undefined; state?: Array | undefined; }; /** @internal */ export declare const PayrollUpdateCustomWithholdings$outboundSchema: z.ZodType; export declare function payrollUpdateCustomWithholdingsToJSON(payrollUpdateCustomWithholdings: PayrollUpdateCustomWithholdings): string; /** @internal */ export type PayrollUpdatePaidTimeOff$Outbound = { name?: string | undefined; hours?: string | undefined; policy_uuid?: string | undefined; final_payout_unused_hours_input?: string | null | undefined; }; /** @internal */ export declare const PayrollUpdatePaidTimeOff$outboundSchema: z.ZodType; export declare function payrollUpdatePaidTimeOffToJSON(payrollUpdatePaidTimeOff: PayrollUpdatePaidTimeOff): string; /** @internal */ export type PayrollUpdateReimbursements$Outbound = { amount?: string | undefined; description?: string | undefined; uuid?: string | undefined; }; /** @internal */ export declare const PayrollUpdateReimbursements$outboundSchema: z.ZodType; export declare function payrollUpdateReimbursementsToJSON(payrollUpdateReimbursements: PayrollUpdateReimbursements): string; /** @internal */ export type PayrollUpdateEmployeeCompensations$Outbound = { employee_uuid?: string | undefined; version?: string | undefined; excluded?: boolean | undefined; payment_method?: string | undefined; memo?: string | undefined; fixed_compensations?: Array | undefined; hourly_compensations?: Array | undefined; deductions?: Array | undefined; custom_withholdings?: PayrollUpdateCustomWithholdings$Outbound | undefined; paid_time_off?: Array | undefined; reimbursements?: Array | undefined; }; /** @internal */ export declare const PayrollUpdateEmployeeCompensations$outboundSchema: z.ZodType; export declare function payrollUpdateEmployeeCompensationsToJSON(payrollUpdateEmployeeCompensations: PayrollUpdateEmployeeCompensations): string; /** @internal */ export declare const WithholdingPayPeriod$outboundSchema: z.ZodNativeEnum; /** @internal */ export type PayrollUpdate$Outbound = { employee_compensations: Array; withholding_pay_period?: string | undefined; skip_regular_deductions?: boolean | undefined; fixed_withholding_rate?: boolean | undefined; }; /** @internal */ export declare const PayrollUpdate$outboundSchema: z.ZodType; export declare function payrollUpdateToJSON(payrollUpdate: PayrollUpdate): string; //# sourceMappingURL=payrollupdate.d.ts.map