Qodex.ai

Preview pay schedule dates

GET {{baseUrl}}/v1/companies/:company_id/pay_schedules/preview?frequency=<string>&anchor_pay_date=<string>&anchor_end_of_pay_period=<string>&day_1=<integer>&day_2=<integer>

Provides a preview of a pay schedule with the specified parameters

scope: pay_schedules:write

Request Params

KeyDatatypeRequiredDescription
frequencystringThe frequency that employees on this pay schedule are paid with Gusto.
anchor_pay_datestringThe first date that employees on this pay schedule are paid with Gusto.
anchor_end_of_pay_periodstringThe last date of the first pay period. This can be the same date as the anchor pay date.
day_1stringAn integer between 1 and 31 indicating the first day of the month that employees are paid. This field is only relevant for pay schedules with the “Twice per month” and “Monthly” frequencies. It will be null for pay schedules with other frequencies.
day_2stringAn integer between 1 and 31 indicating the second day of the month that employees are paid. This field is the second pay date for pay schedules with the "Twice per month" frequency. For semi-monthly pay schedules, set this field to 31. For months shorter than 31 days, we will set the second pay date to the last day of the month. It will be null for pay schedules with other frequencies.

HEADERS

KeyDatatypeRequiredDescription
X-Gusto-API-VersionstringDetermines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.
Acceptstring

RESPONSES

status: OK

{&quot;pay_periods&quot;:[{&quot;check_date&quot;:&quot;2023-12-15&quot;,&quot;end_date&quot;:&quot;2023-12-31&quot;,&quot;start_date&quot;:&quot;2023-10-01&quot;,&quot;run_payroll_by&quot;:&quot;2023-12-13&quot;},{&quot;check_date&quot;:&quot;2024-03-15&quot;,&quot;end_date&quot;:&quot;2024-03-31&quot;,&quot;start_date&quot;:&quot;2024-01-01&quot;,&quot;run_payroll_by&quot;:&quot;2024-03-13&quot;},{&quot;check_date&quot;:&quot;2024-06-14&quot;,&quot;end_date&quot;:&quot;2024-06-30&quot;,&quot;start_date&quot;:&quot;2024-04-01&quot;,&quot;run_payroll_by&quot;:&quot;2024-06-12&quot;},{&quot;check_date&quot;:&quot;2024-09-13&quot;,&quot;end_date&quot;:&quot;2024-09-30&quot;,&quot;start_date&quot;:&quot;2024-07-01&quot;,&quot;run_payroll_by&quot;:&quot;2024-09-11&quot;}],&quot;holidays&quot;:[&quot;2023-10-09&quot;,&quot;2023-11-11&quot;,&quot;2023-11-23&quot;,&quot;2023-12-25&quot;,&quot;2024-01-01&quot;,&quot;2024-01-15&quot;,&quot;2024-02-19&quot;,&quot;2024-05-27&quot;,&quot;2024-06-19&quot;,&quot;2024-07-04&quot;,&quot;2024-09-02&quot;]}