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 { HTTPMetadata } from "../components/httpmetadata.js"; import { PaySchedulePreview } from "../components/payschedulepreview.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; /** * Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */ export declare const GetV1CompaniesCompanyIdPaySchedulesPreviewHeaderXGustoAPIVersion: { readonly TwoThousandAndTwentyFiveMinus06Minus15: "2025-06-15"; }; /** * Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */ export type GetV1CompaniesCompanyIdPaySchedulesPreviewHeaderXGustoAPIVersion = ClosedEnum; /** * The frequency that employees on this pay schedule are paid with Gusto. */ export declare const Frequency: { readonly EveryWeek: "Every week"; readonly EveryOtherWeek: "Every other week"; readonly TwicePerMonth: "Twice per month"; readonly Monthly: "Monthly"; }; /** * The frequency that employees on this pay schedule are paid with Gusto. */ export type Frequency = ClosedEnum; export type GetV1CompaniesCompanyIdPaySchedulesPreviewRequest = { /** * Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */ xGustoAPIVersion?: GetV1CompaniesCompanyIdPaySchedulesPreviewHeaderXGustoAPIVersion | undefined; /** * The UUID of the company */ companyId: string; /** * The frequency that employees on this pay schedule are paid with Gusto. */ frequency: Frequency; /** * The first date that employees on this pay schedule are paid with Gusto. */ anchorPayDate: RFCDate; /** * The last date of the first pay period. This can be the same date as the anchor pay date. */ anchorEndOfPayPeriod: RFCDate; /** * An integer between 1 and 31 indicating the first day of the month that employees are paid. This field is only relevant for pay schedules with the "Twice per month" and "Monthly" frequencies. It will be null for pay schedules with other frequencies. */ day1?: number | undefined; /** * An integer between 1 and 31 indicating the second day of the month that employees are paid. This field is the second pay date for pay schedules with the "Twice per month" frequency. For semi-monthly pay schedules, set this field to 31. For months shorter than 31 days, the second pay date is set to the last day of the month. It will be null for pay schedules with other frequencies. */ day2?: number | undefined; /** * End date for the preview range. If given, this date must be in the future. When unspecified, defaults to 18 months from today. */ endDate?: RFCDate | undefined; /** * Optional UUID of an existing pay schedule. When supplied, the preview is seeded from the persisted schedule — including internal flags (such as arrears handling) that affect period boundaries but are not exposed as request parameters. Any other query parameters override individual attributes on top of the loaded schedule. */ payScheduleUuid?: string | undefined; }; export type GetV1CompaniesCompanyIdPaySchedulesPreviewResponse = { httpMeta: HTTPMetadata; /** * Successful */ paySchedulePreview?: PaySchedulePreview | undefined; }; /** @internal */ export declare const GetV1CompaniesCompanyIdPaySchedulesPreviewHeaderXGustoAPIVersion$outboundSchema: z.ZodNativeEnum; /** @internal */ export declare const Frequency$outboundSchema: z.ZodNativeEnum; /** @internal */ export type GetV1CompaniesCompanyIdPaySchedulesPreviewRequest$Outbound = { "X-Gusto-API-Version": string; company_id: string; frequency: string; anchor_pay_date: string; anchor_end_of_pay_period: string; day_1?: number | undefined; day_2?: number | undefined; end_date?: string | undefined; pay_schedule_uuid?: string | undefined; }; /** @internal */ export declare const GetV1CompaniesCompanyIdPaySchedulesPreviewRequest$outboundSchema: z.ZodType; export declare function getV1CompaniesCompanyIdPaySchedulesPreviewRequestToJSON(getV1CompaniesCompanyIdPaySchedulesPreviewRequest: GetV1CompaniesCompanyIdPaySchedulesPreviewRequest): string; /** @internal */ export declare const GetV1CompaniesCompanyIdPaySchedulesPreviewResponse$inboundSchema: z.ZodType; export declare function getV1CompaniesCompanyIdPaySchedulesPreviewResponseFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=getv1companiescompanyidpayschedulespreview.d.ts.map