Update a pay schedule

put

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

Updates a pay schedule.

scope: pay_schedules:write

Path Params

company_id

string

required

The UUID of the company

pay_schedule_id

string

required

The UUID of the pay schedule

Body Params

version

string

required

The current version of the object. See the versioning guide for information on how to use this field.

frequency

string

enum

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

Allowed:

anchor_pay_date

string

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

anchor_end_of_pay_period

string

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

day_1

integer | null

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 | null

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.

custom_name

string

A custom pay schedule name.

auto_pilot

boolean

With Autopilot® enabled, payroll will run automatically one day before your payroll deadlines.

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:

Responses

404

Not Found

The requested resource does not exist. Make sure the provided UUID is valid.

Language

Credentials

Bearer

Loading…

Response

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

application/json

200Example response

422Unprocessable Entity This may happen when the body of your request contains errors such as invalid_attribute_value, or the request fails due to an invalid_operation. See the Errors Categories guide for more details.