import { GustoEmbeddedCore } from "../core.js"; import { RequestOptions } from "../lib/sdks.js"; import { GustoEmbeddedError } from "../models/errors/gustoembeddederror.js"; import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js"; import { NotFoundErrorObject } from "../models/errors/notfounderrorobject.js"; import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import { UnprocessableEntityError } from "../models/errors/unprocessableentityerror.js"; import { GetV1CompaniesCompanyIdPayPeriodsRequest, GetV1CompaniesCompanyIdPayPeriodsResponse } from "../models/operations/getv1companiescompanyidpayperiods.js"; import { APIPromise } from "../types/async.js"; import { Result } from "../types/fp.js"; /** * Get pay periods for a company * * @remarks * Pay periods are the foundation of payroll. Compensation, time & attendance, taxes, and expense reports all rely on when they happened. * * To begin submitting information for a given payroll, we need to agree on the time period. * * By default, this endpoint returns pay periods starting from 6 months ago to the date today. Use the `start_date` and `end_date` parameters to change the scope of the response. End dates can be up to 3 months in the future and there is no limit on start dates. * * Starting in version 2023-04-01, the `eligible_employees` attribute was removed from the response. The eligible employees for a payroll are determined by the employee_compensations returned from the [PUT /v1/companies/{company_id}/payrolls/{payroll_id}/prepare](ref:put-v1-companies-company_id-payrolls-payroll_id-prepare) endpoint. * * scope: `payrolls:read` * * If set, this operation will use {@link Security.companyAccessAuth} from the global security. */ export declare function paySchedulesGetPayPeriods(client: GustoEmbeddedCore, request: GetV1CompaniesCompanyIdPayPeriodsRequest, options?: RequestOptions): APIPromise>; //# sourceMappingURL=paySchedulesGetPayPeriods.d.ts.map