import * as z from "zod/v3"; import { ClosedEnum } from "../../types/enums.js"; import { GarnishmentChildSupport, GarnishmentChildSupport$Outbound } from "./garnishmentchildsupport.js"; export declare const GarnishmentRequestGarnishmentType: { readonly ChildSupport: "child_support"; readonly FederalTaxLien: "federal_tax_lien"; readonly StateTaxLien: "state_tax_lien"; readonly StudentLoan: "student_loan"; readonly CreditorGarnishment: "creditor_garnishment"; readonly FederalLoan: "federal_loan"; readonly OtherGarnishment: "other_garnishment"; }; export type GarnishmentRequestGarnishmentType = ClosedEnum; /** * Request body for creating a garnishment. */ export type GarnishmentRequest = { /** * Whether or not this garnishment is currently active. */ active?: boolean | undefined; /** * The amount of the garnishment. Either a percentage or a fixed dollar amount. Represented as a float, e.g. "8.00". */ amount: string; /** * The description of the garnishment. */ description?: string | undefined; /** * Whether the garnishment is court ordered. */ courtOrdered: boolean; /** * The specific type of garnishment for court ordered garnishments. */ garnishmentType?: GarnishmentRequestGarnishmentType | null | undefined; /** * The number of times to apply the garnishment. Ignored if recurring is true. */ times?: number | null | undefined; /** * Whether the garnishment should recur indefinitely. */ recurring?: boolean | undefined; /** * The maximum deduction per annum. A null value indicates no maximum. Represented as a float, e.g. "200.00". */ annualMaximum?: string | null | undefined; /** * The maximum deduction per pay period. A null value indicates no maximum. Represented as a float, e.g. "16.00". */ payPeriodMaximum?: string | null | undefined; /** * Whether the amount should be treated as a percentage to be deducted per pay period. */ deductAsPercentage?: boolean | undefined; /** * A maximum total deduction for the lifetime of this garnishment. A null value indicates no maximum. */ totalAmount?: string | null | undefined; /** * Additional child support order details */ childSupport?: GarnishmentChildSupport | null | undefined; }; /** @internal */ export declare const GarnishmentRequestGarnishmentType$outboundSchema: z.ZodNativeEnum; /** @internal */ export type GarnishmentRequest$Outbound = { active: boolean; amount: string; description?: string | undefined; court_ordered: boolean; garnishment_type?: string | null | undefined; times: number | null; recurring: boolean; annual_maximum: string | null; pay_period_maximum: string | null; deduct_as_percentage: boolean; total_amount?: string | null | undefined; child_support?: GarnishmentChildSupport$Outbound | null | undefined; }; /** @internal */ export declare const GarnishmentRequest$outboundSchema: z.ZodType; export declare function garnishmentRequestToJSON(garnishmentRequest: GarnishmentRequest): string; //# sourceMappingURL=garnishmentrequest.d.ts.map