import * as z from "zod/v3"; import { ClosedEnum } from "../../types/enums.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; /** * The status of the external payroll. The status will be `unprocessed` when the external payroll is created and transition to `processed` once tax liabilities are entered and finalized. Once in the `processed` status all actions that can edit an external payroll will be disabled. */ export declare const ExternalPayrollStatus: { readonly Unprocessed: "unprocessed"; readonly Processed: "processed"; }; /** * The status of the external payroll. The status will be `unprocessed` when the external payroll is created and transition to `processed` once tax liabilities are entered and finalized. Once in the `processed` status all actions that can edit an external payroll will be disabled. */ export type ExternalPayrollStatus = ClosedEnum; export type Earnings = { amount?: string | undefined; hours?: string | undefined; earningType?: string | undefined; earningId?: number | undefined; }; export type Benefits = { benefitId?: number | undefined; companyContributionAmount?: string | undefined; employeeDeductionAmount?: string | undefined; }; export type ExternalPayrollTaxes = { taxId?: number | undefined; amount?: string | undefined; }; export type ExternalPayrollItems = { employeeUuid?: string | undefined; earnings?: Array | undefined; benefits?: Array | undefined; taxes?: Array | undefined; }; export type ApplicableEarnings = { earningType?: string | undefined; earningId?: number | undefined; name?: string | undefined; inputType?: string | undefined; category?: string | undefined; }; export type ApplicableBenefits = { id?: number | undefined; description?: string | undefined; active?: boolean | undefined; }; export type ApplicableTaxes = { id?: number | undefined; name?: string | undefined; /** * Some taxes may have an amount withheld from the employee and an amount withheld from the employer, e.g. Social Security. A `true` value indicates this is the employer's amount. */ employerTax?: boolean | undefined; /** * Some taxes may have different rates or reporting requirements depending on if the employee is a resident or non-resident of the tax jurisdiction. */ residentTax?: boolean | undefined; }; /** * Stores metadata of the external payroll. */ export type ExternalPayrollMetadata = { /** * Determines if the external payroll can be deleted. */ deletable?: boolean | undefined; }; /** * The representation of an external payroll. */ export type ExternalPayroll = { /** * The UUID of the external payroll. */ uuid: string; /** * The UUID of the company. */ companyUuid?: string | undefined; /** * External payroll's check date. */ checkDate?: string | undefined; /** * External payroll's pay period start date. */ paymentPeriodStartDate?: string | undefined; /** * External payroll's pay period end date. */ paymentPeriodEndDate?: string | undefined; /** * The status of the external payroll. The status will be `unprocessed` when the external payroll is created and transition to `processed` once tax liabilities are entered and finalized. Once in the `processed` status all actions that can edit an external payroll will be disabled. */ status?: ExternalPayrollStatus | undefined; /** * External payroll items for employees */ externalPayrollItems?: Array | undefined; /** * Applicable earnings based on company provisioning. */ applicableEarnings?: Array | undefined; /** * Applicable benefits based on company provisioning. */ applicableBenefits?: Array | null | undefined; /** * Applicable taxes based on company provisioning. */ applicableTaxes?: Array | undefined; /** * Stores metadata of the external payroll. */ metadata?: ExternalPayrollMetadata | undefined; }; /** @internal */ export declare const ExternalPayrollStatus$inboundSchema: z.ZodNativeEnum; /** @internal */ export declare const Earnings$inboundSchema: z.ZodType; export declare function earningsFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const Benefits$inboundSchema: z.ZodType; export declare function benefitsFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const ExternalPayrollTaxes$inboundSchema: z.ZodType; export declare function externalPayrollTaxesFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const ExternalPayrollItems$inboundSchema: z.ZodType; export declare function externalPayrollItemsFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const ApplicableEarnings$inboundSchema: z.ZodType; export declare function applicableEarningsFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const ApplicableBenefits$inboundSchema: z.ZodType; export declare function applicableBenefitsFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const ApplicableTaxes$inboundSchema: z.ZodType; export declare function applicableTaxesFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const ExternalPayrollMetadata$inboundSchema: z.ZodType; export declare function externalPayrollMetadataFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const ExternalPayroll$inboundSchema: z.ZodType; export declare function externalPayrollFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=externalpayroll.d.ts.map