import * as z from "zod/v3"; import { ClosedEnum } from "../../types/enums.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import { ContractorPaymentSummary } from "../components/contractorpaymentsummary.js"; import { ContractorPaymentSummaryByDates } from "../components/contractorpaymentsummarybydates.js"; import { HTTPMetadata } from "../components/httpmetadata.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 GetV1CompaniesCompanyIdContractorPaymentsHeaderXGustoAPIVersion: { 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 GetV1CompaniesCompanyIdContractorPaymentsHeaderXGustoAPIVersion = ClosedEnum; export type GetV1CompaniesCompanyIdContractorPaymentsRequest = { /** * 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?: GetV1CompaniesCompanyIdContractorPaymentsHeaderXGustoAPIVersion | undefined; /** * The UUID of the company */ companyId: string; /** * The time period for which to retrieve contractor payments */ startDate: string; /** * The time period for which to retrieve contractor payments. If left empty, defaults to today's date. */ endDate: string; /** * The UUID of the contractor. When specified, will load all payments for that contractor. */ contractorUuid?: string | undefined; /** * Display contractor payments results group by check date if set to true. */ groupByDate?: boolean | undefined; /** * The page that is requested. When unspecified, will load all objects unless endpoint forces pagination. */ page?: number | undefined; /** * Number of objects per page. For majority of endpoints will default to 25 */ per?: number | undefined; }; /** * A JSON object containing contractor payments information */ export type GetV1CompaniesCompanyIdContractorPaymentsResponseBody = ContractorPaymentSummary | ContractorPaymentSummaryByDates; export type GetV1CompaniesCompanyIdContractorPaymentsResponse = { httpMeta: HTTPMetadata; /** * A JSON object containing contractor payments information */ oneOf?: ContractorPaymentSummary | ContractorPaymentSummaryByDates | undefined; }; /** @internal */ export declare const GetV1CompaniesCompanyIdContractorPaymentsHeaderXGustoAPIVersion$outboundSchema: z.ZodNativeEnum; /** @internal */ export type GetV1CompaniesCompanyIdContractorPaymentsRequest$Outbound = { "X-Gusto-API-Version": string; company_id: string; start_date: string; end_date: string; contractor_uuid?: string | undefined; group_by_date?: boolean | undefined; page?: number | undefined; per?: number | undefined; }; /** @internal */ export declare const GetV1CompaniesCompanyIdContractorPaymentsRequest$outboundSchema: z.ZodType; export declare function getV1CompaniesCompanyIdContractorPaymentsRequestToJSON(getV1CompaniesCompanyIdContractorPaymentsRequest: GetV1CompaniesCompanyIdContractorPaymentsRequest): string; /** @internal */ export declare const GetV1CompaniesCompanyIdContractorPaymentsResponseBody$inboundSchema: z.ZodType; export declare function getV1CompaniesCompanyIdContractorPaymentsResponseBodyFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const GetV1CompaniesCompanyIdContractorPaymentsResponse$inboundSchema: z.ZodType; export declare function getV1CompaniesCompanyIdContractorPaymentsResponseFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=getv1companiescompanyidcontractorpayments.d.ts.map