import {z} from 'zod' export type GetApiV1CompaniesCompanyIdPayrollsArgs = {'X-Gusto-API-Version'?: '2026-06-15' | undefined, company_id: string, processing_statuses?: (Array<'processed' | 'unprocessed'>) | undefined, payroll_types?: (Array<'regular' | 'off_cycle' | 'external'>) | undefined, processed?: boolean | undefined, include_off_cycle?: boolean | undefined, include?: (Array<'taxes' | 'payroll_status_meta' | 'totals' | 'risk_blockers' | 'reversals'>) | undefined, start_date?: string | undefined, end_date?: string | undefined, date_filter_by?: 'check_date' | undefined, page?: number | undefined, per?: number | undefined, sort_order?: ('asc' | 'desc') | undefined}; export type GetApiV1CompaniesCompanyIdPayrollsOptions = {baseUrl?: string | undefined, CompanyAccessAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const payrollDeadlineType = z.string(); export const payrollCheckDateType = z.string(); export const payrollProcessedType = z.boolean(); export const payrollProcessedDateType = z.string().nullable(); export const payrollCalculatedAtType = z.string().nullable(); export const payrollPayrollUuidType = z.string(); export const payrollCompanyUuidType = z.string(); export const payrollOffCycleType = z.boolean(); export const offCycleReasonType = z.enum(["Adhoc", "Benefit reversal", "Bonus", "Correction", "Dismissed employee", "Hired employee", "Wage correction", "Tax reconciliation", "Reversal", "Disability insurance distribution", "Transition from old pay schedule"]).nullable(); export const autoPilotType = z.boolean(); export const payrollExternalType = z.boolean(); export const payrollFinalTerminationPayrollType = z.boolean(); export const payrollWithholdingPayPeriodType = z.enum(["Every week", "Every other week", "Twice per month", "Monthly", "Quarterly", "Semiannually", "Annually"]).nullable(); export const payrollSkipRegularDeductionsType = z.boolean().nullable(); export const payrollFixedWithholdingRateType = z.boolean().nullable(); export const payrollPayPeriodType = z.object({start_date: z.string().nullable().optional(), end_date: z.string().nullable().optional(), pay_schedule_uuid: z.string().nullable().optional()}); export const payrollPayrollStatusMetaType = z.object({cancellable: z.boolean().optional(), expected_check_date: z.string().optional(), initial_check_date: z.string().nullable().optional(), expected_debit_time: z.string().optional(), payroll_late: z.boolean().nullable().optional(), initial_debit_cutoff_time: z.string().optional()}); export const payrollTotalsType = z.object({company_debit: z.string().optional(), net_pay_debit: z.string().min(1).optional(), tax_debit: z.string().optional(), reimbursement_debit: z.string().optional(), child_support_debit: z.string().optional(), reimbursements: z.string().optional(), net_pay: z.string().optional(), gross_pay: z.string().optional(), employee_bonuses: z.string().optional(), employee_commissions: z.string().optional(), employee_cash_tips: z.string().optional(), employee_paycheck_tips: z.string().optional(), additional_earnings: z.string().optional(), owners_draw: z.string().optional(), check_amount: z.string().optional(), employer_taxes: z.string().optional(), employee_taxes: z.string().optional(), benefits: z.string().optional(), employee_benefits_deductions: z.string().optional(), imputed_pay: z.string().optional(), deferred_payroll_taxes: z.string().optional(), other_deductions: z.string().optional()}); export const payrollCompanyTaxesType = z.array(z.object({name: z.string().optional(), employer: z.boolean().optional(), amount: z.string().optional()})); export const payrollTaxesType = z.array(z.object({name: z.string().optional(), employer: z.boolean().optional(), amount: z.number().optional()})); export const payrollPaymentSpeedChangedType = z.object({original_check_date: z.string().optional(), current_check_date: z.string().optional(), original_debit_date: z.string().optional(), current_debit_date: z.string().optional(), reason: z.string().optional()}); export const createdAtType = z.string(); export const payrollSubmissionBlockerType = z.object({blocker_type: z.string().optional(), blocker_name: z.string().optional(), unblock_options: z.array(z.object({unblock_type: z.string().optional(), check_date: z.string().optional(), metadata: z.record(z.string(), z.unknown()).optional()})).optional(), selected_option: z.string().nullable().optional(), status: z.enum(["unresolved", "resolved"]).optional()}); export const payrollSubmissionBlockersType = z.array(payrollSubmissionBlockerType); export const payrollCreditBlockerUnblockOptionSubmitWire = z.object({unblock_type: z.literal("submit_wire"), check_date: z.string(), metadata: z.object({wire_in_amount: z.string(), wire_in_deadline: z.string(), wire_in_request_uuid: z.string()})}); export const payrollCreditBlockerUnblockOptionSubmitBankScreenshot = z.object({unblock_type: z.literal("submit_bank_screenshot"), check_date: z.string(), metadata: z.object({information_request_uuid: z.string(), bank_account_last_four_digits: z.string().nullable().optional()})}); export const payrollCreditBlockerUnblockOptionRespondToHighRiskFraudRfi = z.object({unblock_type: z.literal("respond_to_high_risk_fraud_rfi"), check_date: z.string(), metadata: z.object({information_request_uuid: z.string()})}); export const payrollCreditBlockerUnblockOptionWaitForReverseWire = z.object({unblock_type: z.literal("wait_for_reverse_wire"), check_date: z.string(), metadata: z.object({})}); export const payrollCreditBlockerType = z.object({blocker_type: z.string().optional(), blocker_name: z.string().optional(), unblock_options: z.array(z.discriminatedUnion("unblock_type", [payrollCreditBlockerUnblockOptionSubmitWire, payrollCreditBlockerUnblockOptionSubmitBankScreenshot, payrollCreditBlockerUnblockOptionRespondToHighRiskFraudRfi, payrollCreditBlockerUnblockOptionWaitForReverseWire])).optional(), selected_option: z.string().nullable().optional(), status: z.enum(["unresolved", "pending_review", "resolved", "failed"]).optional()}); export const payrollCreditBlockersType = z.array(payrollCreditBlockerType); export const metadataWithOneEntity = z.object({entity_type: z.string().optional(), entity_uuid: z.string().optional(), valid_from: z.string().nullable().optional(), valid_up_to: z.string().nullable().optional(), key: z.string().nullable().optional(), state: z.string().nullable().optional()}).and(z.record(z.string(), z.unknown())); export const entityErrorObject = z.object({error_key: z.string(), category: z.string(), message: z.string().optional(), metadata: z.union([z.object({entities: z.array(metadataWithOneEntity)}), z.object({entity_type: z.string().optional(), entity_uuid: z.string().optional(), valid_from: z.string().nullable().optional(), valid_up_to: z.string().nullable().optional(), key: z.string().nullable().optional(), state: z.string().nullable().optional()}).and(z.record(z.string(), z.unknown()))]).optional(), errors: z.array(z.object({error_key: z.string().optional(), category: z.string().optional(), message: z.string().optional(), metadata: z.object({}).optional()})).optional()}); export const payrollProcessingRequest = z.object({status: z.enum(["calculating", "calculate_success", "submitting", "submit_success", "processing_failed"]).optional(), errors: z.array(entityErrorObject).optional()}).nullable(); export const payrollPartnerOwnedDisbursementType = z.boolean().nullable(); export const payroll = z.object({payroll_deadline: payrollDeadlineType.optional(), check_date: payrollCheckDateType.optional(), processed: payrollProcessedType.optional(), processed_date: payrollProcessedDateType.optional(), calculated_at: payrollCalculatedAtType.optional(), uuid: payrollPayrollUuidType.optional(), payroll_uuid: payrollPayrollUuidType.optional(), company_uuid: payrollCompanyUuidType.optional(), off_cycle: payrollOffCycleType.optional(), off_cycle_reason: offCycleReasonType.optional(), auto_payroll: autoPilotType.optional(), external: payrollExternalType.optional(), final_termination_payroll: payrollFinalTerminationPayrollType.optional(), withholding_pay_period: payrollWithholdingPayPeriodType.optional(), skip_regular_deductions: payrollSkipRegularDeductionsType.optional(), fixed_withholding_rate: payrollFixedWithholdingRateType.optional(), pay_period: payrollPayPeriodType.optional(), payroll_status_meta: payrollPayrollStatusMetaType.optional(), totals: payrollTotalsType.optional(), company_taxes: payrollCompanyTaxesType.optional(), payroll_taxes: payrollTaxesType.optional(), payment_speed_changed: payrollPaymentSpeedChangedType.optional(), created_at: createdAtType.optional(), submission_blockers: payrollSubmissionBlockersType.optional(), credit_blockers: payrollCreditBlockersType.optional(), processing_request: payrollProcessingRequest.optional(), partner_owned_disbursement: payrollPartnerOwnedDisbursementType.optional()}); export const payrollList = z.array(payroll); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Get all payrolls for a company * * GET /v1/companies/{company_id}/payrolls */ export const getApiV1CompaniesCompanyIdPayrolls = async (args: GetApiV1CompaniesCompanyIdPayrollsArgs, options?: GetApiV1CompaniesCompanyIdPayrollsOptions) => { const {baseUrl = "https://api.gusto-demo.com", fetch: fetchFn = fetch, CompanyAccessAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['X-Gusto-API-Version'] != null) headers.set("X-Gusto-API-Version", String(args['X-Gusto-API-Version'])) if (args.processing_statuses != null) query.append("processing_statuses", args.processing_statuses.join(',')) if (args.payroll_types != null) query.append("payroll_types", args.payroll_types.join(',')) if (args.processed != null) query.append("processed", String(args.processed)) if (args.include_off_cycle != null) query.append("include_off_cycle", String(args.include_off_cycle)) if (args.include != null) query.append("include", args.include.join(',')) if (args.start_date != null) query.append("start_date", String(args.start_date)) if (args.end_date != null) query.append("end_date", String(args.end_date)) if (args.date_filter_by != null) query.append("date_filter_by", String(args.date_filter_by)) if (args.page != null) query.append("page", String(args.page)) if (args.per != null) query.append("per", String(args.per)) if (args.sort_order != null) query.append("sort_order", String(args.sort_order)) if (CompanyAccessAuth !== undefined) headers.set('authorization', `Bearer ${CompanyAccessAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/companies/${encodeURIComponent(String(args.company_id))}/payrolls${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(payrollList, await res.json()) };