Preview pay schedule dates

get

https://api.gusto-demo.com/v1/companies/{company_id}/pay_schedules/preview

Provides a preview of a pay schedule with the specified parameters for the next 18 months.

scope: pay_schedules:write

Path Params

company_id

string

required

The UUID of the company

Query Params

frequency

string

enum

required

The frequency that employees on this pay schedule are paid with Gusto.

Allowed:

anchor_pay_date

string

required

The first date that employees on this pay schedule are paid with Gusto.

anchor_end_of_pay_period

string

required

The last date of the first pay period. This can be the same date as the anchor pay date.

day_1

integer

An 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_2

integer

An 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

X-Gusto-API-Version

string

enum

Defaults to 2024-03-01

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Allowed:

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK