import * as z from "zod/v3"; import { ClosedEnum } from "../../types/enums.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import { HTTPMetadata } from "../components/httpmetadata.js"; import { InvoiceData } from "../components/invoicedata.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; export type GetInvoicesInvoicePeriodSecurity = { systemAccessAuth: string; }; /** * 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 GetInvoicesInvoicePeriodHeaderXGustoAPIVersion: { 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 GetInvoicesInvoicePeriodHeaderXGustoAPIVersion = ClosedEnum; export type GetInvoicesInvoicePeriodRequest = { /** * 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?: GetInvoicesInvoicePeriodHeaderXGustoAPIVersion | undefined; /** * The month we are calculating the invoice for. Must be in YYYY-MM format */ invoicePeriod: string; /** * 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; /** * Filter companies returned in the active_companies response, will return an error if company not active during provided invoice period. i.e. `?company_uuids=781922d8-e780-4b6b-bf74-ee303166d022,bbbca930-7322-491c-ba7f-98707a52a9c5` */ companyUuids?: string | undefined; }; export type GetInvoicesInvoicePeriodResponse = { httpMeta: HTTPMetadata; /** * OK */ invoiceData?: InvoiceData | undefined; }; /** @internal */ export type GetInvoicesInvoicePeriodSecurity$Outbound = { SystemAccessAuth: string; }; /** @internal */ export declare const GetInvoicesInvoicePeriodSecurity$outboundSchema: z.ZodType; export declare function getInvoicesInvoicePeriodSecurityToJSON(getInvoicesInvoicePeriodSecurity: GetInvoicesInvoicePeriodSecurity): string; /** @internal */ export declare const GetInvoicesInvoicePeriodHeaderXGustoAPIVersion$outboundSchema: z.ZodNativeEnum; /** @internal */ export type GetInvoicesInvoicePeriodRequest$Outbound = { "X-Gusto-API-Version": string; invoice_period: string; page?: number | undefined; per?: number | undefined; company_uuids?: string | undefined; }; /** @internal */ export declare const GetInvoicesInvoicePeriodRequest$outboundSchema: z.ZodType; export declare function getInvoicesInvoicePeriodRequestToJSON(getInvoicesInvoicePeriodRequest: GetInvoicesInvoicePeriodRequest): string; /** @internal */ export declare const GetInvoicesInvoicePeriodResponse$inboundSchema: z.ZodType; export declare function getInvoicesInvoicePeriodResponseFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=getinvoicesinvoiceperiod.d.ts.map